A YANG Data Model for CMIS Access and Control

Pluggable Digital Coherent Optics (DCO) transceivers enable routers or switches to directly connect to optical network (e.g., DWDM or OTN). Pluggable DCO transceivers, such as CFP2-DCO and QSFP-DD DCO, implement optical connectors (i.e., Tx and Rx) and a Digital Signal Processor (DSP), and provide higher data rates (100 Gbps, 400 Gbps, and beyond) and flexible data transport. Pluggable DCO transceivers, equiped by a platform device (e.g., a router or a switch), is generally controlled by network OS (NOS) running on the device with Content Management Interoperability Specificatins (CMIS) which is an open standard protocol designed to facilitate interoperability between management systems. The specification is defined in . Vender-specific differences in the interpretation of certain CMIS definitions and in the capabilities of pluggable DCO transceivers can lead to inconsistent behavior. Therefore, each NOS needs explicitly support each transceiver type. Additionally, existing data models such as OpenConfig and IETF YANG may not fully present or utilize all transceiver capabilities (Ref. ). CMIS also allows vendor-specific extensions of its transceiver features by using custom pages. For example, CMIS custom pages can be used for non-standardized functions. However, there is currently no standardized schema for external systems to access or manage CMIS custom pages. This document defines a YANG data model that enables external systems to directly manage DSP registers in pluggable DCO transceivers installed in routers and switches, in compliance with the CMIS specification.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" this document are to be interpreted as described in BCP14, , when, and only when, they appear in all capitals, as shown here. The terms and their definitions used in this specification are described below: CMIS (Common Management Interface Specifications): A generic management communication interface together with a generic management interaction protocol between host and managed modules. The specification is defined in ; NACM (Network Configuration Access Control Model): A standard access control model to restrict NETCONF or RESTCONF protocol access for particular users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. The specification is defined in . NETCONF (Network Configuration Protocol): Mechanisms to install, manipulate, and delete the configuration of network devices. The definitions and specification is described in ; RESTCONF: An HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastore concepts defined in NETCONF. The specification is defined in . The following terms of NETCONF defined in are also used in this specification: (NETCONF) client configuration data datastore message remote procedure call (RPC) (NETCONF) server state data (NETCONF) user This document makes use of the terms defined in .

The following acronyms are used in this document: Customer Edge Command Data Block Digital Coherent Optics Digital Signal Processor Dense Wavelength Division Multiplexing Generalized Signal-to-Noise Ratio Inter-Integrated Circuit Network Operating System Network Management System Optical Transport Network Quality of Transmission Third Party Application Wavelength Division Multiplexing

The tree diagrams used in this document follow the notation defined in .

In this document, names of data nodes and other data model objects are prefixed using the standard prefix associated with the corresponding YANG imported modules. The proposed modules are augments to the ietf-interface . The details of the modules are described in . Prefix YANG module Reference if ietf-interfaces cmis-ctrl ietf-cmis-control RFC XXXX cmis-ctrl-pm ietf-cmis-control-primitive RFC XXXX cmis-ctrl-act ietf-cmis-control-action RFC XXXX cmis-ctrl-rpc ietf-cmis-control-rpc RFC XXXX ietf-cmis-mon cmis-monitor RFC XXXX Note: The RFC Editor will replace XXXX with the number assigned to the RFC once this draft becomes an RFC.

This document defines the following YANG modules for the management of CMIS-capable pluggable DCO transceivers. ietf-cmis-control (base model, mandatory) ietf-cmis-control-primitive (optional) ietf-cmis-control-rpc (optional) ietf-cmis-control-action (optional) ietf-cmis-monitor (optional) Each module is an augment to the ietf-interface. It allows the user to set the operating mode of CMIS for control pluggable devices as well as other operational parameters.

The structure of ietf-cmis-control is shown below:

Note that the values related to CMIS pages are defined in .

The YANG module of "ietf-cmis-control" is defined as below.

file "ietf-cmis-control.yang" module ietf-cmis-control { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-cmis-control"; prefix cmis-ctrl; import ietf-interfaces { prefix if; } organization "IETF CCAMP Working Group"; contact "WG Web: WG List: Editor: Shunsuke Homma Editor: Hitoshi Irino "; description "This YANG module defines a data model for the management of CMIS (Common Management Interface Specification) pages as specified by OIF. It enables configuration and retrieval of CMIS page data, including access types and value fields, to support the management of pluggable optical modules via NETCONF or RESTCONF. Copyright (c) 2025 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices."; // RFC Ed.: replace XXXX with actual RFC number and remove this note revision "2025-04-21" { description "Initial revision."; reference "I-D.hi-ccamp-cmis-control-yang-00"; } /* * CMIS control data nodes */ typedef access-type { type enumeration { enum rw { description "A readable and writable element."; } enum rww { description "A readable and writable element that can be modified by the module."; } enum ro { description "A read-only element."; } enum wo { description "A write-only element."; } enum wo/sc { description "A write-only element with self-clearing side effect."; } enum ro/cor { description "A write-only element with celan-on-read side effect."; } } description "Defines access types for CMIS elements."; } grouping cmis-page { description "Parameters stored in the CMIS page"; leaf page-num{ type uint8 { range "0 .. 255"; } mandatory true; description "The number of the CMIS page."; } leaf bank { type uint8; mandatory true; description "The banks corresponding to the CMIS page."; } leaf page-access-type { type access-type; config false; description "Access type of the CMIS page."; } leaf description { type string; description "The description of the CMIS page."; } list value { key "offset"; description "The value contained in the CMIS page."; leaf offset { type uint8; mandatory true; description "The memory address of the value."; } leaf size { type uint8 { range "1 .. 128"; } mandatory true; description "The memory size of the value."; } leaf value-access-type { type access-type; config false; description "Access type of the target value."; } leaf value-data { type binary; mandatory true; description "The data contained in the value. It is writable only when the access-type is not Read-Only or Read-Only with clean-on-read side effect."; } leaf description { type string; description "The description of the value."; } } } grouping cmis-pages { description "The list of the accessible CMIS pages supported by the pluggable device accommodated into the interface."; list cmis-page { key "page-num"; uses cmis-page; } } grouping cmis-control { description "Parameters for primitive CMIS control of the pluggable device equipped in the interface."; leaf cmis-enabled { type boolean; default "false"; config false; description "The availability of the CMIS for control the pluggable device equipped in the interface. If the device does not support CMIS, this value is false."; } leaf cmis-version { type string; config false; description "The version of the CMIS by the pluggable device."; } uses cmis-pages; } /* * Augment Interface */ augment "/if:interfaces/if:interface" { container cmis-control { uses cmis-control; } } }

]]>






  
  
  This document provides a more primitive YANG data model for CMIS access and control. 
  This is called as "ietf-cmis-control-primitive" or "primitive mode" and it doesn't 
  manage supplemental information, such as access-types or description, of the fields in 
  a CMIS page, and treat accessed memories as flat data structure.
  
  
  
  This model enables implementation of server (i.e., network node) side to be simple, but on the other hand, 
  client (i.e., controller) side is needed strict management of data of CMIS pages. For example, when a 
  client sends a request to change any value, it needs to comprehend the page number, the 
  offset, and the data size in which the data is contained.
  

  
  The tree diagram of "ietf-cmis-control-primitive" is shown below:
  



  
  The "ietf-cmis-control-primitive" module is defined as below.
  

 file "ietf-cmis-control-primitive.yang"
module ietf-cmis-control-primitive {
  yang-version 1.1;
  namespace "urn:ietf:params:xml:ns:yang:ietf-cmis-control-primitive";
  prefix cmis-ctrl-pm;

  import ietf-interfaces {
    prefix if;
  }

  organization
    "IETF CCAMP Working Group";

  contact
    "WG Web:   
    WG List:  

    Editor:   Shunsuke Homma
      
    
    Editor:   Hitoshi Irino
      ";

  description
    "This YANG module defines a data model for the management 
    of CMIS (Common Management Interface Specification) pages 
    as specified by OIF with RPC. It enables configuration and 
    retrieval of CMIS page data, including access types and 
    value fields, to support the management of pluggable optical 
    modules via NETCONF or RESTCONF.

    Copyright (c) 2025 IETF Trust and the persons identified
    as authors of the code.  All rights reserved.

    Redistribution and use in source and binary forms, with or
    without modification, is permitted pursuant to, and
    subject to the license terms contained in, the Revised
    BSD License set forth in Section 4.c of the IETF Trust's
    Legal Provisions Relating to IETF Documents
    (http://trustee.ietf.org/license-info).

    This version of this YANG module is part of RFC XXXX
    (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
    for full legal notices.";
  
// RFC Ed.: replace XXXX with actual RFC number and remove this note

    revision "2025-4-21" {
      description
        "Initial revision.";
      reference
        "I-D.hi-ccamp-cmis-control-yang-00";
    }

    augment "/if:interfaces/if:interface" {
  action cmis-read {
    description "Read CMIS register under this interface.";
    input {
      leaf page {
        type uint8;
        mandatory true;
      }
      leaf bank {
        type uint8;
        mandatory true;
      }
      leaf offset {
        type uint8;
        mandatory true;
      }
      leaf size {
        type uint8;
        default 1;
      }
    }
    output {
      leaf data {
        type binary;
      }
    }
  }

  action cmis-write {
    description "Write CMIS register under this interface.";
    input {
      leaf page {
        type uint8;
        mandatory true;
      }
      leaf bank {
        type uint8;
        mandatory true;
      }
      leaf offset {
        type uint8;
        mandatory true;
      }
      leaf data {
        type binary;
        mandatory true;
      }
    }
  }
}


]]>




  
  The "ietf-cmis-control-action" module defines actions-based controls of CMIS pages with NETCONF RPC.
  



  
  The YANG module of "ietf-cmis-control" is defined as below.
  

 file "ietf-cmis-control-rpc"
module ietf-cmis-control-action {
  yang-version 1.1;
  namespace "urn:ietf:params:xml:ns:yang:ietf-cmis-control-action";
  prefix cmis-ctrl-act;

  import ietf-interfaces {
    prefix if;
  }

  organization
    "IETF CCAMP Working Group";

  contact
    "WG Web:   
    WG List:  

    Editor:   Shunsuke Homma
      
    
    Editor:   Hitoshi Irino
      ";

  description
    "This YANG module defines a data model for action-based 
    management of CMIS (Common Management Interface Specification) 
    pages as specified by OIF. It enables configuration and 
    retrieval of CMIS page data, including access types and value 
    fields, to support the management of pluggable optical modules 
    via NETCONF or RESTCONF.

    Copyright (c) 2025 IETF Trust and the persons identified
    as authors of the code.  All rights reserved.

    Redistribution and use in source and binary forms, with or
    without modification, is permitted pursuant to, and
    subject to the license terms contained in, the Revised
    BSD License set forth in Section 4.c of the IETF Trust's
    Legal Provisions Relating to IETF Documents
    (http://trustee.ietf.org/license-info).

    This version of this YANG module is part of RFC XXXX
    (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
    for full legal notices.";
  
// RFC Ed.: replace XXXX with actual RFC number and remove this note
  revision "2025-10-11" {
    description "Initial revision.";
  }

  augment "/if:interfaces/if:interface" {
    description
      "Add CMIS read/write actions under interface.";

    action cmis-read {
      description
        "Read CMIS register via action context.";
      input {
        leaf page {
          type uint8;
          mandatory true;
          description "The number of the CMIS page.";
        }
        leaf bank {
          type uint8;
          mandatory true;
          description "The banks corresponding to the CMIS page.";
        }
        leaf offset {
          type uint8;
          mandatory true;
          description "The memory address of the value.";
        }
        leaf size {
          type uint8{
            range "1 .. 128";
          }
          mandatory true;
          description "The memory size of the value.";
        }
      }
      output {
        leaf data {
          type binary;
          description "Raw register data.";
        }
      }
    }

    action cmis-write {
      description
        "Write CMIS register data via action context.";
      input {
        leaf page {
          type uint8;
          mandatory true;
          description "The number of the CMIS page.";
        }
        leaf bank {
          type uint8;
          mandatory true;
          description "The banks corresponding to the CMIS page.";
        }
        leaf offset {
          type uint8;
          mandatory true;
          description "The memory address of the value.";
        }
        leaf data {
          type binary;
          mandatory true;
          description "Data to write.";
        }
      }
      output {
        leaf status {
          type enumeration {
            enum success;
            enum not-permitted {
              description "Write request was rejected due to access-type or policy";
            }
            enum io-error {
              description "I/O error during write";
            }
            enum invalid-params {
              description "Bad parameters";
            }
          }
          description "Result of the write operation.";
        }

        leaf post-write-value {
          type binary;
          description
            "Optional read-back of the target value after write.
             Present only if the implementation performed a read-back
             (e.g., for 'rw' registers). Not present for 'wo' registers
             or when no-readback was requested/possible.";
        }
      }
    }
  }
}

]]>

  






  
  The "ietf-cmis-control-rpc" module provides a schema to control CMIS pages with NETCONF RPC.
  

  
  The tree diagram of "ietf-cmis-control-rpc" is shown below.
  

 /if:interfaces/interface/name
    |  |  +---w page              uint8
    |  |  +---w bank              uint8
    |  |  +---w offset            uint8
    |  |  +---w size?             uint8
    |  +--ro output
    |     +--ro data?   binary
    +---x cmis-write
       +---w input
       |  +---w interface-name    -> /if:interfaces/interface/name
       |  +---w page              uint8
       |  +---w bank              uint8
       |  +---w offset            uint8
       |  +---w data              binary
       +--ro output
          +--ro status?             enumeration
          +--ro post-write-value?   binary
]]>

  
  The YANG module of "ietf-cmis-control-rpc" is defined as below.
  

 file "ietf-cmis-control-rpc"
module ietf-cmis-rpc {
  yang-version 1.1;
  namespace "urn:ietf:params:xml:ns:yang:ietf-cmis-rpc";
  prefix cmis-rpc;

  import ietf-interfaces {
    prefix if;
  }

  organization
    "IETF CCAMP Working Group";

  contact
    "WG Web:   
    WG List:  

    Editor:   Shunsuke Homma
      

    Editor:   Hitoshi Irino
      ";

  description
    "This YANG module defines a data model for the management
    of CMIS (Common Management Interface Specification) pages
    as specified by OIF with RPC. It enables configuration and
    retrieval of CMIS page data, including access types and
    value fields, to support the management of pluggable
    optical modules via NETCONF or RESTCONF.

    Copyright (c) 2025 IETF Trust and the persons identified
    as authors of the code.  All rights reserved.

    Redistribution and use in source and binary forms, with or
    without modification, is permitted pursuant to, and
    subject to the license terms contained in, the Revised
    BSD License set forth in Section 4.c of the IETF Trust's
    Legal Provisions Relating to IETF Documents
    (http://trustee.ietf.org/license-info).

    This version of this YANG module is part of RFC XXXX
    (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
    for full legal notices.";

// RFC Ed.: replace XXXX with actual RFC number and remove this note

  revision "2025-10-11" {
    description
      "Initial revision.";
    reference
      "I-D.hi-ccamp-cmis-control-yang-01";
  }

  rpc cmis-read {
    description
      "Read a CMIS register from a pluggable DCO transceiver.";
    input {
      leaf interface-name {
        type leafref{
	  path "/if:interfaces/if:interface/if:name";
	}
        mandatory true;
        description "Target interface name.";
      }
      leaf page {
        type uint8;
        mandatory true;
      }
      leaf bank {
        type uint8;
        mandatory true;
      }
      leaf offset {
        type uint8;
        mandatory true;
      }
      leaf size {
        type uint8;
        default 1;
        description "Number of bytes to read.";
      }
    }
    output {
      leaf data {
        type binary;
        description "Raw register data.";
      }
    }
  }

  rpc cmis-write {
    description
      "Write CMIS register data to a pluggable module.";
    input {
      leaf interface-name {
        type leafref{
          path "/if:interfaces/if:interface/if:name";
        }
        mandatory true;
        description "Target interface name.";
      }
      leaf page {
        type uint8;
        mandatory true;
        description "The number of the CMIS page.";
      }
      leaf bank {
        type uint8;
        mandatory true;
        description "The banks corresponding to the CMIS page.";
      }
      leaf offset {
        type uint8;
        mandatory true;
        description "The memory address of the value.";
      }
      leaf data {
        type binary;
        mandatory true;
        description "Data to write.";
      }
    }
    output {
      leaf status {
        type enumeration {
          enum success;
          enum not-permitted {
            description "Write request was rejected due to access-type or policy";
          }
          enum io-error {
            description "I/O error during write";
          }
          enum invalid-params {
            description "Bad parameters";
          }
        }
        description "Result of the write operation.";
      }

      leaf post-write-value {
        type binary;
        description
          "Optional read-back of the target value after write.
           Present only if the implementation performed a read-back
           (e.g., for 'rw' registers). Not present for 'wo' registers
           or when no-readback was requested/possible.";
      }
    }
  }
}

]]>

  



  
  The "ietf-cmis-monitor" module provides monitoring capabilities for CMIS-based DCO transceivers.
  

  
  The tree diagram of "ietf-cmis-monitor" is shown below.
  

 /if:interfaces/interface/name
        +--rw monitor-target
        |  +--rw page      uint8
        |  +--rw bank      uint8
        |  +--rw offset    uint8
        |  +--rw size?     uint8
        +--rw condition
        |  +--rw condition-type    enumeration
        |  +--rw threshold?        decimal64
        |  +--rw delta-rate?       decimal64
        +--rw interval-ms?      uint32
        +--rw enabled?          boolean

  notifications:
    +---n cmis-monitor-event
       +--ro interface-name?   string
       +--ro rule-id?          string
       +--ro monitor-target
       |  +--ro page      uint8
       |  +--ro bank      uint8
       |  +--ro offset    uint8
       |  +--ro size?     uint8
       +--ro condition-type?   enumeration
       +--ro current-value?    binary
       +--ro threshold?        decimal64
       +--ro delta-rate?       decimal64
       +--ro timestamp?        yang:date-and-time
  ]]>

    
    The YANG module of "ietf-cmis-monitor" is defined as below.
    
  
 file "ietf-cmis-control-rpc"
module ietf-cmis-monitor {
  yang-version 1.1;
  namespace "urn:ietf:params:xml:ns:yang:ietf-cmis-monitor";
  prefix cmis-mon;

  import ietf-interfaces {
    prefix if;
  }
  import ietf-yang-types {
    prefix yang;
  }

  organization
    "IETF CCAMP Working Group";

  contact
    "WG Web:   
     WG List:  

    Editor:   Shunsuke Homma
      

    Editor:   Hitoshi Irino
      ";

  description
    "This module provides monitoring capabilities for CMIS-based 
     optical modules. Users can define monitor rules for CMIS 
     registers identified by page/bank/offset/size. Notifications 
     are generated when threshold or delta-rate conditions are met.";

  revision "2025-10-11" {
    description "Initial revision.";
  }

  grouping monitor-target {
    description
      "Target CMIS register to monitor.";
    leaf page {
      type uint8;
      mandatory true;
      description "The number of the CMIS page.";
    }
    leaf bank {
      type uint8;
      mandatory true;
      description "The bank of the CMIS page.";
    }
    leaf offset {
      type uint8;
      mandatory true;
      description "The memory address of the value.";
    }
    leaf size {
      type uint8 {
        range "1 .. 128";
      }
      description "The memory size of the monitored value.";
    }
  }

  container monitors {
    description "Container for all monitor rules.";

    list monitor-rule {
      key "id";
      description "Monitoring rule.";

      leaf id {
        type string;
        description "Unique identifier of the rule.";
      }

      leaf interface-name {
        type leafref {
          path "/if:interfaces/if:interface/if:name";
        }
        mandatory true;
        description "Target interface of the monitored CMIS module.";
      }

      container monitor-target {
        uses monitor-target;
      }

      container condition {
        description "Condition to trigger notification.";
        leaf condition-type {
          type enumeration {
            enum threshold;
            enum delta-rate;
          }
          mandatory true;
          description "Type of condition.";
        }
        leaf threshold {
          type decimal64 {
            fraction-digits 2;
          }
          description "Threshold value for triggering notification (only used for threshold type).";
        }
        leaf delta-rate {
          type decimal64 {
            fraction-digits 2;
          }
          description "Maximum allowed change per interval (only used for delta-rate type).";
        }
      }

      leaf interval-ms {
        type uint32;
        default 1000;
        description "Monitoring interval in milliseconds.";
      }

      leaf enabled {
        type boolean;
        default true;
        description "Enable or disable this monitor rule.";
      }
    }
  }

  notification cmis-monitor-event {
    description "Notification raised when monitor rule condition is met.";

    leaf interface-name {
      type string;
      description "Interface name of the monitored module.";
    }

    leaf rule-id {
      type string;
      description "ID of the rule that triggered this notification.";
    }

    container monitor-target {
      uses monitor-target;
    }

    leaf condition-type {
      type enumeration {
        enum threshold;
        enum delta-rate;
      }
      description "The type of condition that was met.";
    }

    leaf current-value {
      type binary;
      description "Current value of the monitored register.";
    }

    leaf threshold {
      type decimal64 {
        fraction-digits 2;
      }
      description "Threshold value (present if threshold type).";
    }

    leaf delta-rate {
      type decimal64 {
        fraction-digits 2;
      }
      description "Delta-rate value (present if delta-rate type).";
    }

    leaf timestamp {
      type yang:date-and-time;
      description "Time when the notification was generated.";
    }
  }
}

]]>