huawei-cli

CLI window configuration.

  • Version: 2019-10-26

    huawei-cli@2019-10-26


    
      module huawei-cli {
    
        yang-version 1;
    
        namespace "urn:huawei:yang:huawei-cli";
    
        prefix cli;
    
        import huawei-extension {
          prefix ext;
        }
        import ietf-yang-types {
          prefix yang;
        }
    
        organization
          "Huawei Technologies Co., Ltd.";
    
        contact
          "Huawei Industrial Base
         Bantian, Longgang
         Shenzhen 518129
         People's Republic of China
         Website: http://www.huawei.com
         Email: support@huawei.com";
    
        description "CLI window configuration.";
    
        revision "2019-10-26" {
          description "Initial revision.";
          reference
            "Huawei private.";
    
        }
    
        ext:task-name "cli";
    
        typedef processing-status-type {
          type enumeration {
            enum "initial" {
              value 0;
              description
                "The diagnostic information generation has not been performed since this startup.";
            }
            enum "processing" {
              value 1;
              description
                "The diagnostic information generation is processing.";
            }
            enum "completed" {
              value 2;
              description
                "The diagnostic information generation is completed successfully.";
            }
            enum "failed" {
              value 3;
              description
                "The diagnostic information generation is completed unsuccessfully.";
            }
          }
          description
            "The type of diagnostic information generation processing status.";
        }
    
        typedef fail-reason-type {
          type enumeration {
            enum "no-error" {
              value 0;
              description "No error.";
            }
            enum "prepare-failed" {
              value 1;
              description
                "Failed to prepare for execution.";
            }
            enum "command-locked" {
              value 2;
              description
                "Diagnostic information command is being locked now by other method, please wait for a moment.";
            }
            enum "diag-source-error" {
              value 3;
              description
                "There are some errors in the diagnostic commands to be executed.";
            }
            enum "save-diag-file-failed" {
              value 4;
              description
                "Failed to save the diagnosis file.";
            }
            enum "cpu-high-end" {
              value 5;
              description
                "The command execution failed because the CPU usage could not fall below 70% within 300s.";
            }
            enum "internal-error" {
              value 6;
              description
                "An error occurred in the internal processing.";
            }
          }
          description
            "The type of failed reason.";
        }
    
        container cli {
          description
            "CLI window configuration.";
          container header {
            description
              "Configure the header displayed upon user login or session startup.";
            choice login-information {
              description
                "Login authentication header, which is displayed before a user enters the user name and password in the CLI window.";
              case head-login-text {
                description
                  "Specify the information of login banner.";
                leaf login-text {
                  type string {
                    length "1..478";
                  }
                  description
                    "Text of a login authentication header.";
                }
              }  // case head-login-text
    
              case head-login-file {
                description
                  "Specify the filename of login banner.";
                leaf login-file {
                  type string {
                    length "1..64";
                    pattern '(\w+)(:/)(\w.*)';
                  }
                  description
                    "Name of a login authentication header file.";
                }
              }  // case head-login-file
            }  // choice login-information
    
            choice shell-information {
              description
                "Session startup header, which is displayed after a user enters the user name and password in the CLI window.";
              case head-shell-text {
                description
                  "Specify the information of shell banner.";
                leaf shell-text {
                  type string {
                    length "1..478";
                  }
                  description
                    "Text of a session startup header.";
                }
              }  // case head-shell-text
    
              case head-shell-file {
                description
                  "Specify the filename of shell banner.";
                leaf shell-file {
                  type string {
                    length "1..64";
                    pattern '(\w+)(:/)(\w.*)';
                  }
                  description
                    "Name of a session startup header file.";
                }
              }  // case head-shell-file
            }  // choice shell-information
          }  // container header
    
          container query-diagnose-information-generate-process {
            config false;
            description
              "Operational state of diagnose information generation.";
            leaf processsing-status {
              type processing-status-type;
              description "Processing status.";
            }
    
            leaf fail-reason {
              type fail-reason-type;
              must
                "(../processsing-status='failed')";
              description
                "Fail reason of last query diagnose information.";
            }
    
            leaf last-generate-time {
              type yang:date-and-time;
              must
                "(../processsing-status!='initial')";
              description
                "Last time of query diagnose information.";
            }
          }  // container query-diagnose-information-generate-process
        }  // container cli
    
        rpc generate-diagnose-information {
          description
            "Generate diagnose information.";
        }  // rpc generate-diagnose-information
      }  // module huawei-cli
    

© 2023 YumaWorks, Inc. All rights reserved.