cisco-ia

DMI self-management YANG module for IOS Copyright (c) 2016, 2018-2019 by Cisco Systems, Inc. All rights reserved.

  • Version: 2021-07-01

    cisco-ia@2021-07-01


    
      module cisco-ia {
    
        yang-version 1;
    
        namespace
          "http://cisco.com/yang/cisco-ia";
    
        prefix cisco-ia;
    
        import cisco-semver {
          prefix cisco-semver;
        }
        import cisco-self-mgmt {
          prefix cisco-sfm;
        }
        import tailf-common {
          prefix tailf;
        }
        import ietf-yang-types {
          prefix yang;
        }
    
        organization "Cisco Systems";
    
        contact "<mailto:cs-yang@cisco.com>";
    
        description
          "DMI self-management YANG module for IOS
         Copyright (c) 2016, 2018-2019 by Cisco Systems, Inc.
         All rights reserved.";
    
        revision "2021-07-01" {
          description
            "Add netconf-session-id and current-time RPCs.";
          reference
            "TBD";
    
        }
    
        revision "2019-11-19" {
          description
            "- Obsolete internal knob nodes of the cisco-ia model
           - Add parser context to bad CLI detail";
          reference
            "TBD";
    
        }
    
        revision "2019-07-01" {
          description
            "- Establish semantic version baseline
           - Deprecate SNMP configuration";
        }
    
        revision "2018-08-03" {
          description
            "Add parser message blacklist capability";
          reference
            "TBD";
    
        }
    
        revision "2018-07-25" {
          description
            "Add pivot commands (for internal use only).";
          reference
            "TBD";
    
        }
    
        revision "2018-03-28" {
          description
            "Add parser response to error information for
           bad cli";
          reference
            "TBD";
    
        }
    
        revision "2018-01-22" {
          description
            "Marked odm-log-level obsolete";
          reference
            "TBD";
    
        }
    
        revision "2017-03-02" {
          description "Remove unused RPCs";
          reference
            "TBD";
    
        }
    
        revision "2017-01-29" {
          description
            "Add the ability to query if a sync is in progress.
           Add option to sync-from RPC to ignore preserve
           paths.";
          reference
            "TBD";
    
        }
    
        revision "2017-01-27" {
          description
            "Fix the SNMP community string Xpath to comply with new
           confd 6.3.1 rule enforcement";
          reference
            "TBD";
    
        }
    
        revision "2017-01-12" {
          description
            "Change intelligent-sync default
           to true";
          reference
            "TBD";
    
        }
    
        revision "2016-12-08" {
          description
            "Add extended error reporting";
          reference
            "TBD";
    
        }
    
        revision "2016-10-17" {
          description "Add preserve NED paths";
          reference
            "TBD";
    
        }
    
        revision "2016-10-04" {
          description
            "Add the ability to configure the SNMP community string
           and remove the blocking container must clauses";
          reference
            "TBD";
    
        }
    
        revision "2016-08-22" {
          description "Add dmp-install RPC";
          reference
            "TBD";
    
        }
    
        revision "2016-06-30" {
          description
            "Add black list CLI lists,
           correct formatting per IETF standard";
          reference
            "TBD";
    
        }
    
        revision "2016-05-20" {
          description
            "Fix intelligent-sync default and convert
           leaf-lists into lists";
          reference
            "TBD";
    
        }
    
        revision "2016-05-16" {
          description "Add augment statement";
          reference
            "TBD";
    
        }
    
        revision "2016-05-13" {
          description
            "Change confd-cfg-blocking-enabled default
           and odm-log-level type";
          reference
            "TBD";
    
        }
    
        revision "2016-05-09" {
          description
            "Add leaf for persistence checking";
          reference
            "TBD";
    
        }
    
        revision "2016-05-04" {
          description
            "Add tail-f annotations to boolean leaves";
          reference
            "TBD";
    
        }
    
        revision "2016-04-24" {
          description
            "Add dynamic PRC messages list, cleanup";
          reference
            "TBD";
    
        }
    
        revision "2016-04-22" {
          description
            "Increase parser msg ignore max elements";
          reference
            "TBD";
    
        }
    
        revision "2016-04-17" {
          description
            "Add container for snmp trap control, replacingbooleans for individual traps.";
          reference
            "TBD";
    
        }
    
        revision "2016-04-07" {
          description
            "Update description with copyright notice.";
          reference
            "TBD";
    
        }
    
        revision "2016-03-15" {
          description
            "Add intelligent sync control";
          reference
            "TBD";
    
        }
    
        cisco-semver:module-version "1.0.0";
        tailf:error-info {
          leaf "severity" {
            type "enumeration" {
              enum "info_cli";
              enum "error_cli";
              enum "critical_cli";
            }
          }
          container "detail" {
            list "bad-cli" {
              key "bad-command";
              leaf "bad-command" {
                type "string";
                description "Command rejected by the network element";
              }
              leaf "error-location" {
                type "int16";
                description "Location in the command line
    where the CLI parser detected an error";
              }
              leaf "parser-response" {
                type "string";
                description "Parser response due to rejected command";
              }
              leaf "parser-context" {
                type "string";
                description "Parser context of rejected command";
              }
            }
          }
        }
    
        typedef parser-msg-processing-method {
          type enumeration {
            enum "blacklist" {
              value 0;
              description
                "Check all parser output against a set
               of known errors and abort the transaction
               if matched.";
            }
            enum "whitelist" {
              value 1;
              description
                "Check all parser output against a set
               of known messages to ignore and abort
               the transaction if not matched.";
            }
          }
        }
    
        typedef cia-sync-type {
          type enumeration {
            enum "disabled" {
              value 0;
              description
                "Do no synchronize the DMI
               database from the Network Element";
            }
            enum "without-defaults" {
              value 1;
              description
                "Collect \"show running\" from
               the Network Element";
            }
            enum "include-defaults" {
              value 2;
              description
                "Collect \"show running all\" from
               the Network Element";
            }
          }
          description
            "Controls the elements sent to the DMI
           database from the Network Element";
        }
    
        typedef cia-log-level {
          type enumeration {
            enum "none" {
              value 0;
              description "No logging";
            }
            enum "error" {
              value 1;
              description "Log errors only";
            }
            enum "warning" {
              value 2;
              description
                "Log errors and warnings only";
            }
            enum "information" {
              value 3;
              description
                "Log errors, warnings, and information only";
            }
            enum "debug" {
              value 4;
              description
                "Log errors, warnings, information,
               and debug messages";
            }
          }
          description "Logging levels for DMI";
        }
    
        typedef onep-log-level {
          type enumeration {
            enum "none" {
              value 0;
              description "No logging";
            }
            enum "fatal" {
              value 1;
              description
                "Log fatal events only";
            }
            enum "error" {
              value 2;
              description
                "Log fatal events and errors only";
            }
            enum "warning" {
              value 3;
              description
                "Log fatal events, errors, and warnings only";
            }
            enum "information" {
              value 4;
              description
                "Log fatal events, errors, warnings,
               and information only";
            }
            enum "debug" {
              value 5;
              description
                "Log fatal events, errors, warnings, information,
               and debug messages";
            }
            enum "trace" {
              value 6;
              description "Log all messages";
            }
          }
          description "Logging levels for Onep";
        }
    
        typedef syslog-severity {
          type enumeration {
            enum "none" {
              value 8;
              description "No logging";
            }
            enum "emergency" {
              value 0;
              description "Emergency Level Msg";
            }
            enum "alert" {
              value 1;
              description "Alert Level Msg";
            }
            enum "critical" {
              value 2;
              description "Critical Level Msg";
            }
            enum "error" {
              value 3;
              description "Error Level Msg";
            }
            enum "warning" {
              value 4;
              description "Warning Level Msg";
            }
            enum "notice" {
              value 5;
              description
                "Notification Level Msg";
            }
            enum "info" {
              value 6;
              description
                "Informational Level Msg";
            }
            enum "debug" {
              value 7;
              description "Debugging Level Msg";
            }
          }
          description
            "Standard Syslog logging levels)";
        }
    
        rpc sync-from {
          description
            "Synchronize the network element's
           running-configuration to ConfD.";
          input {
            leaf sync-defaults {
              type empty;
              description
                "Sends the output of
               \"show running all\" line
               by line to Confd.";
            }
    
            leaf ignore-presrv-paths {
              type empty;
              description
                "Sync everything under /native.
               Ignore any preserve paths.";
            }
          }
    
          output {
            leaf result {
              type string;
              description
                "Output returned by the network element";
            }
          }
        }  // rpc sync-from
    
        rpc save-config {
          description
            "Copy the running-config to
           startup-config on the Network
           Element.";
          output {
            leaf result {
              type string;
              description
                "Output returned by the network element";
            }
          }
        }  // rpc save-config
    
        rpc netconf-session-id {
          description
            "Returns device-assigned netconf session id for the
           netconf session in which this RPC is invoked.";
          output {
            leaf result {
              type string;
              description
                "Output returned by the network element";
            }
          }
        }  // rpc netconf-session-id
    
        rpc current-time {
          description
            "Returns current time on device.";
          output {
            leaf result {
              type string;
              description
                "Output returned by the network element";
            }
          }
        }  // rpc current-time
    
        rpc is-syncing {
          description
            "Checks to see if sync from the
           network element to the running data store
           is in progress.";
          output {
            leaf result {
              type string;
              description
                "Output returned by the network element";
            }
          }
        }  // rpc is-syncing
    
        rpc checkpoint {
          description
            "Create a configuration rollback checkpoint.
           Equivalent to the \"archive config\" CLI";
          output {
            leaf result {
              type string;
              description
                "Output returned by the network element";
            }
          }
        }  // rpc checkpoint
    
        rpc revert {
          description
            "Cancel the timed rollback and trigger the
           rollback immediately, or to reset parameters
           for the timed rollback";
          input {
            leaf now {
              type empty;
              description
                "To cancel the timed rollback and
               trigger the rollback immediately";
            }
    
            leaf timer {
              type int16 {
                range "1..120";
              }
              description
                "Reset parameters for the timed rollback";
            }
    
            leaf idle {
              type int16 {
                range "1..120";
              }
              description
                "Maximum allowable time period of no activity
               before reverting to the saved configuration.";
            }
          }
    
          output {
            leaf result {
              type string;
              description
                "Output returned by the network element";
            }
          }
        }  // rpc revert
    
        rpc rollback {
          description
            "Replaces the current running configuration
           file with a saved Cisco IOS XE configuration file.";
          input {
            leaf target-url {
              type string;
              mandatory true;
              description
                "Cisco IOS XE configuration file that is to
               replace the current running configuration";
            }
    
            leaf verbose {
              type boolean;
              default "false";
              description
                "Display a list of the command lines applied by
               the Cisco IOS XE software parser during each pass
               of the configuration replace operation. The total
               number of passes performed is also displayed.";
            }
    
            leaf nolock {
              type boolean;
              default "false";
              description
                "Disables the locking of the running
               configuration file that prevents other users
               from changing the running configuration
               during a configuration replace operation.";
            }
    
            leaf revert-on-error {
              type empty;
              description
                "Reverts to the original configuration upon
               error.";
            }
    
            leaf revert-timer {
              type int16 {
                range "1..120";
              }
              description
                "Reverts to the original configuration if
               specified time elapses.";
            }
          }
    
          output {
            leaf result {
              type string;
              description
                "Output returned by the network element";
            }
          }
        }  // rpc rollback
      }  // module cisco-ia
    

© 2023 YumaWorks, Inc. All rights reserved.