huawei-diagnostic-tools-bier

BIER diagnosis tool.

  • Version: 2020-08-24

    huawei-diagnostic-tools-bier@2020-08-24


    
      submodule huawei-diagnostic-tools-bier {
    
        yang-version 1;
    
        belongs-to huawei-diagnostic-tools {
            prefix diagnostic-tools;
        }
    
        import huawei-pub-type {
          prefix pub-type;
        }
        import ietf-inet-types {
          prefix inet;
        }
        import huawei-extension {
          prefix ext;
        }
    
        include huawei-diagnostic-tools-common;
        include huawei-diagnostic-tools-type;
    
        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 "BIER diagnosis tool.";
    
        revision "2020-08-24" {
          description "Modify description.";
          reference
            "Huawei private.";
    
        }
    
        revision "2020-07-04" {
          description "Initial revision.";
          reference
            "Huawei private.";
    
        }
    
    
        rpc bier-start-ipv6-ping {
          description
            "Start BIER IPv6 ping test.";
          input {
            leaf test-name {
              type string {
                length "1..32";
              }
              mandatory true;
              description "Test name.";
            }
    
            leaf sub-domain-id {
              type uint8 {
                range "0..255";
              }
              mandatory true;
              description
                "Bit Index Explicit Replication (BIER) subdomain.";
            }
    
            leaf bit-string-len {
              type bit-string-len-type;
              mandatory true;
              description
                "BFR bit string length.";
            }
    
            choice target-bfr {
              description
                "Specify the target BFR.";
              case single-bfrid {
                description
                  "Specify a single BFR-ID.";
                leaf bfr-id {
                  type uint16 {
                    range "1..65535";
                  }
                  mandatory true;
                  description
                    "Specify the BFR-ID of the target router.";
                }
              }  // case single-bfrid
    
              case bfrid-range {
                description
                  "Specify the target BFR-ID range.";
                leaf start-bfr-id {
                  type uint16 {
                    range "1..65535";
                  }
                  mandatory true;
                  description
                    "Specify the minimum BFR-ID of the target routers.";
                }
    
                leaf end-bfr-id {
                  type uint16 {
                    range "1..65535";
                  }
                  must
                    "(../end-bfr-id >= ../start-bfr-id)";
                  mandatory true;
                  description
                    "Specify the maximum BFR-ID of the target routers.";
                }
              }  // case bfrid-range
            }  // choice target-bfr
    
            leaf timeout {
              type uint32 {
                range "100..65535";
              }
              units "ms";
              default "2000";
              description
                "Time to wait for a response packet after a test packet is sent.";
            }
    
            leaf pkt-count {
              type uint32 {
                range "1..65535";
              }
              default "5";
              description
                "Number of sent test packets.";
            }
    
            leaf interval {
              type uint32 {
                range "100..10000";
              }
              units "ms";
              default "2000";
              description
                "Interval for sending test packets.";
            }
    
            leaf ttl {
              type uint8 {
                range "1..255";
              }
              default "255";
              description "Time to live.";
            }
    
            leaf source-address {
              type inet:ipv6-address-no-zone;
              description "Source address.";
            }
    
            leaf dest-udp-port {
              type uint16 {
                range "1..65535";
              }
              default "49100";
              description
                "Destination UDP port of echo request.";
            }
          }
        }  // rpc bier-start-ipv6-ping
    
        rpc bier-stop-ipv6-ping {
          ext:node-ref "/diagnostic-tools:diagnostic-tools/diagnostic-tools:bier/diagnostic-tools:ipv6-ping-results";
          description
            "Stop BIER IPv6 ping test.";
          input {
            leaf test-name {
              type leafref {
                path "/diagnostic-tools:diagnostic-tools/diagnostic-tools:bier/diagnostic-tools:ipv6-ping-results/diagnostic-tools:ipv6-ping-result/diagnostic-tools:test-name";
              }
              mandatory true;
              description "Test name.";
            }
          }
        }  // rpc bier-stop-ipv6-ping
    
        rpc bier-delete-ipv6-ping {
          ext:node-ref "/diagnostic-tools:diagnostic-tools/diagnostic-tools:bier/diagnostic-tools:ipv6-ping-results";
          description
            "Delete BIER IPv6 ping test.";
          input {
            leaf test-name {
              type leafref {
                path "/diagnostic-tools:diagnostic-tools/diagnostic-tools:bier/diagnostic-tools:ipv6-ping-results/diagnostic-tools:ipv6-ping-result/diagnostic-tools:test-name";
              }
              mandatory true;
              description "Test name.";
            }
          }
        }  // rpc bier-delete-ipv6-ping
    
        rpc bier-start-ipv6-trace {
          description
            "Start BIER IPv6 trace test.";
          input {
            leaf test-name {
              type string {
                length "1..32";
              }
              mandatory true;
              description "Test name.";
            }
    
            leaf sub-domain-id {
              type uint8 {
                range "0..255";
              }
              mandatory true;
              description
                "Bit Index Explicit Replication (BIER) subdomain.";
            }
    
            leaf bit-string-len {
              type bit-string-len-type;
              mandatory true;
              description
                "BFR bit string length.";
            }
    
            choice target-bfr {
              description
                "Specify the target BFR.";
              case single-bfrid {
                description
                  "Specify a single BFR-ID.";
                leaf bfr-id {
                  type uint16 {
                    range "1..65535";
                  }
                  mandatory true;
                  description
                    "Specify the BFR-ID of the target router.";
                }
              }  // case single-bfrid
    
              case bfrid-range {
                description
                  "Specify the target BFR-ID range.";
                leaf start-bfr-id {
                  type uint16 {
                    range "1..65535";
                  }
                  mandatory true;
                  description
                    "Specify the minimum BFR-ID of the target routers.";
                }
    
                leaf end-bfr-id {
                  type uint16 {
                    range "1..65535";
                  }
                  must
                    "(../end-bfr-id >= ../start-bfr-id)";
                  mandatory true;
                  description
                    "Specify the maximum BFR-ID of the target routers.";
                }
              }  // case bfrid-range
            }  // choice target-bfr
    
            leaf timeout {
              type uint32 {
                range "100..65535";
              }
              units "ms";
              default "2000";
              description
                "Time to wait for response packets after a test packet is sent.";
            }
    
            leaf max-ttl {
              type uint8 {
                range "1..255";
              }
              must
                "(../max-ttl >= ../first-ttl)";
              default "30";
              description
                "Specify the maximum TTL of the test packets.";
            }
    
            leaf first-ttl {
              type uint8 {
                range "1..255";
              }
              must
                "(../max-ttl >= ../first-ttl)";
              default "1";
              description
                "TTL of the first packet in a test.";
            }
    
            leaf source-address {
              type inet:ipv6-address-no-zone;
              description "Source address.";
            }
    
            leaf dest-udp-port {
              type uint16 {
                range "1..65535";
              }
              default "49100";
              description
                "Destination UDP port of echo request.";
            }
    
            leaf entropy {
              type uint32 {
                range "0..1048575";
              }
              default "0";
              description
                "The entropy is used for route selection in load balancing scenarios.";
            }
          }
        }  // rpc bier-start-ipv6-trace
    
        rpc bier-stop-ipv6-trace {
          ext:node-ref "/diagnostic-tools:diagnostic-tools/diagnostic-tools:bier/diagnostic-tools:ipv6-trace-results";
          description
            "Stop BIER IPv6 trace test.";
          input {
            leaf test-name {
              type leafref {
                path "/diagnostic-tools:diagnostic-tools/diagnostic-tools:bier/diagnostic-tools:ipv6-trace-results/diagnostic-tools:ipv6-trace-result/diagnostic-tools:test-name";
              }
              mandatory true;
              description "Test name.";
            }
          }
        }  // rpc bier-stop-ipv6-trace
    
        rpc bier-delete-ipv6-trace {
          ext:node-ref "/diagnostic-tools:diagnostic-tools/diagnostic-tools:bier/diagnostic-tools:ipv6-trace-results";
          description
            "Delete BIER IPv6 trace test.";
          input {
            leaf test-name {
              type leafref {
                path "/diagnostic-tools:diagnostic-tools/diagnostic-tools:bier/diagnostic-tools:ipv6-trace-results/diagnostic-tools:ipv6-trace-result/diagnostic-tools:test-name";
              }
              mandatory true;
              description "Test name.";
            }
          }
        }  // rpc bier-delete-ipv6-trace
      }  // submodule huawei-diagnostic-tools-bier
    

© 2023 YumaWorks, Inc. All rights reserved.