Cisco-IOS-XR-ping-act

This module contains a collection of YANG definitions for Cisco IOS-XR ping action package configuration. Copyright (c) 2016-20...

  • Version: 2019-10-01

    Cisco-IOS-XR-ping-act@2019-10-01


    
      module Cisco-IOS-XR-ping-act {
    
        yang-version 1;
    
        namespace
          "http://cisco.com/ns/yang/Cisco-IOS-XR-ping-act";
    
        prefix ping-act;
    
        import cisco-semver {
          prefix semver;
        }
    
        include Cisco-IOS-XR-ipv4-ping-act;
        include Cisco-IOS-XR-ipv6-ping-act;
    
        organization "Cisco Systems, Inc.";
    
        contact
          "Cisco Systems, Inc.
    Customer Service
    
    Postal: 170 West Tasman Drive
    San Jose, CA 95134
    
    Tel: +1 800 553-NETS
    
    E-mail: cs-yang@cisco.com";
    
        description
          "This module contains a collection of YANG definitions
    for Cisco IOS-XR ping action package configuration.
    
    Copyright (c) 2016-2019 by Cisco Systems, Inc.
    All rights reserved.";
    
        revision "2019-10-01" {
          description
            "Made changes to be RFC6087 compliant";
        }
    
        revision "2019-04-05" {
          description
            "Establish semantic version baseline.";
        }
    
        revision "2018-10-01" {
          description "IOS XR 6.2.1 revision.";
        }
    
        semver:module-version "1.1.0";
        semver:module-version "1.0.0";
    
        rpc ping {
          description "Send echo messages";
          input {
            container destination {
              presence "ping input";
              description "Ping destination";
              leaf destination {
                type string;
                mandatory true;
                description
                  "Ping destination address or hostname";
              }
    
              leaf repeat-count {
                type uint64 {
                  range "1..64";
                }
                default "5";
                description
                  "Number of ping packets to be sent out";
              }
    
              leaf data-size {
                type uint64 {
                  range "36..18024";
                }
                default "100";
                description
                  "Size of ping packet";
              }
    
              leaf timeout {
                type uint64 {
                  range "0..36";
                }
                default "2";
                description "Timeout in seconds";
              }
    
              leaf interval {
                type uint32 {
                  range "0..3600";
                }
                default "10";
                description
                  "Ping interval in milli seconds";
              }
    
              leaf pattern {
                type xr:Hex-integer;
                description
                  "Pattern of payload data";
              }
    
              leaf sweep {
                type boolean;
                description "Sweep is enabled";
              }
    
              leaf vrf-name {
                type string;
                description "VRF name";
              }
    
              leaf source {
                type string;
                description
                  "Source address or interface";
              }
    
              leaf verbose {
                type boolean;
                description
                  "Validate return packet";
              }
    
              leaf type-of-service {
                type uint8 {
                  range "0..255";
                }
                description "Type of Service";
              }
    
              leaf do-not-frag {
                type boolean;
                description "Do Not Fragment";
              }
    
              leaf validate {
                type boolean;
                description
                  "Validate return packet";
              }
    
              leaf priority {
                type uint8 {
                  range "0..15";
                }
                description
                  "Priority of the packet";
              }
    
              leaf outgoing-interface {
                type string;
                description
                  "Outgoing interface, needed in case of ping to link local address";
              }
    
              container flowlabel {
                description
                  "Flowlabel value or flowlabel random,
    if both are given then flowabel value is chosen.";
                leaf value {
                  type uint32 {
                    range "0..1048575";
                  }
                  description
                    "Flowlabel of the packet";
                }
    
                leaf random {
                  type empty;
                  description
                    "Random flowlabel value of the packet,
    repeats after every 5 packets";
                }
              }  // container flowlabel
    
              container use-srv6-end-op-sid {
                presence
                  "enable srv6 END.OP operations";
                description
                  "Use End.OP SID in Segment Routing Header";
                leaf user-end-op-sid {
                  type inet:ipv6-address;
                  description
                    "IPv6 End.OP address";
                }
              }  // container use-srv6-end-op-sid
            }  // container destination
    
            list ipv4 {
              key "destination";
              description "Ping IPv4";
              leaf destination {
                type string;
                mandatory true;
                description
                  "Ping destination address or hostname";
              }
    
              leaf repeat-count {
                type uint64 {
                  range "1..64";
                }
                default "5";
                description
                  "Number of ping packets to be sent out";
              }
    
              leaf data-size {
                type uint64 {
                  range "36..18024";
                }
                default "100";
                description
                  "Size of ping packet";
              }
    
              leaf timeout {
                type uint64 {
                  range "0..36";
                }
                default "2";
                description "Timeout in seconds";
              }
    
              leaf interval {
                type uint32 {
                  range "0..3600";
                }
                default "10";
                description
                  "Ping interval in milli seconds";
              }
    
              leaf pattern {
                type xr:Hex-integer;
                description
                  "Pattern of payload data";
              }
    
              leaf sweep {
                type boolean;
                description "Sweep is enabled";
              }
    
              leaf vrf-name {
                type string;
                description "VRF name";
              }
    
              leaf source {
                type string;
                description
                  "Source address or interface";
              }
    
              leaf verbose {
                type boolean;
                description
                  "Validate return packet";
              }
    
              leaf type-of-service {
                type uint8 {
                  range "0..255";
                }
                description "Type of Service";
              }
    
              leaf do-not-frag {
                type boolean;
                description "Do Not Fragment";
              }
    
              leaf validate {
                type boolean;
                description
                  "Validate return packet";
              }
            }  // list ipv4
    
            container ipv6 {
              presence "ipv6 ping input";
              description "Ping IPv6";
              leaf destination {
                type string;
                mandatory true;
                description
                  "Ping destination address or hostname";
              }
    
              leaf repeat-count {
                type uint64 {
                  range "1..64";
                }
                default "5";
                description
                  "Number of ping packets to be sent out";
              }
    
              leaf data-size {
                type uint64 {
                  range "36..18024";
                }
                default "100";
                description
                  "Size of ping packet";
              }
    
              leaf timeout {
                type uint64 {
                  range "0..36";
                }
                default "2";
                description "Timeout in seconds";
              }
    
              leaf interval {
                type uint32 {
                  range "0..3600";
                }
                default "10";
                description
                  "Ping interval in milli seconds";
              }
    
              leaf pattern {
                type xr:Hex-integer;
                description
                  "Pattern of payload data";
              }
    
              leaf sweep {
                type boolean;
                description "Sweep is enabled";
              }
    
              leaf vrf-name {
                type string;
                description "VRF name";
              }
    
              leaf source {
                type string;
                description
                  "Source address or interface";
              }
    
              leaf verbose {
                type boolean;
                description
                  "Validate return packet";
              }
    
              leaf priority {
                type uint8 {
                  range "0..15";
                }
                description
                  "Priority of the packet";
              }
    
              leaf outgoing-interface {
                type string;
                description
                  "Outgoing interface, needed in case of ping to link local address";
              }
    
              container flowlabel {
                description
                  "Flowlabel value or flowlabel random,
    if both are given then flowabel value is chosen.";
                leaf value {
                  type uint32 {
                    range "0..1048575";
                  }
                  description
                    "Flowlabel of the packet";
                }
    
                leaf random {
                  type empty;
                  description
                    "Random flowlabel value of the packet,
    repeats after every 5 packets";
                }
              }  // container flowlabel
    
              container use-srv6-end-op-sid {
                presence
                  "enable srv6 END.OP operations";
                description
                  "Use End.OP SID in Segment Routing Header";
                leaf user-end-op-sid {
                  type inet:ipv6-address;
                  description
                    "IPv6 End.OP address";
                }
              }  // container use-srv6-end-op-sid
            }  // container ipv6
          }
    
          output {
            container ping-response {
              description "Ping response";
              list ipv4 {
                key "destination";
                description "Ping IPv4 response";
                leaf destination {
                  type string;
                  mandatory true;
                  description
                    "Ping destination address or hostname";
                }
    
                leaf repeat-count {
                  type uint64 {
                    range "1..64";
                  }
                  default "5";
                  description
                    "Number of ping packets to be sent out";
                }
    
                leaf data-size {
                  type uint64 {
                    range "36..18024";
                  }
                  default "100";
                  description
                    "Size of ping packet";
                }
    
                leaf timeout {
                  type uint64 {
                    range "0..36";
                  }
                  default "2";
                  description
                    "Timeout in seconds";
                }
    
                leaf interval {
                  type uint32 {
                    range "0..3600";
                  }
                  default "10";
                  description
                    "Ping interval in milli seconds";
                }
    
                leaf pattern {
                  type xr:Hex-integer;
                  description
                    "Pattern of payload data";
                }
    
                leaf sweep {
                  type boolean;
                  description "Sweep is enabled";
                }
    
                container replies {
                  description
                    "IPv4 ping replies";
                  list reply {
                    key "reply-index";
                    description
                      "IPv4 ping reply";
                    leaf reply-index {
                      type uint64 {
                        range "1..2147483647";
                      }
                      description
                        "Index of the reply list";
                    }
    
                    leaf result {
                      type string;
                      description
                        "Response for each packet";
                    }
    
                    container broadcast-reply-addresses {
                      description
                        "IPv4 ping broadcast reply addresses";
                      list broadcast-reply-address {
                        key "reply-address";
                        description
                          "IPv4 ping broadcast reply address";
                        leaf reply-address {
                          type string;
                          description
                            "Broadcast reply address";
                        }
    
                        leaf result {
                          type string;
                          description
                            "Sign for each reply packet";
                        }
                      }  // list broadcast-reply-address
                    }  // container broadcast-reply-addresses
                  }  // list reply
                }  // container replies
    
                leaf hits {
                  type uint64;
                  description
                    "Number of packets reach to destination and get reply back";
                }
    
                leaf total {
                  type uint64;
                  description
                    "Total number of packets sent out";
                }
    
                leaf success-rate {
                  type uint64;
                  description
                    "Successful rate of ping";
                }
    
                leaf rtt-min {
                  type uint64;
                  description
                    "Minimum value of Round Trip Time";
                }
    
                leaf rtt-avg {
                  type uint64;
                  description
                    "Average value of Round Trip Time";
                }
    
                leaf rtt-max {
                  type uint64;
                  description
                    "Maximum value of Round Trip Time";
                }
    
                leaf sweep-min {
                  type uint32;
                  description
                    "Minimum value of sweep size";
                }
    
                leaf sweep-max {
                  type uint64;
                  description
                    "Maximum value of sweep size";
                }
    
                leaf rotate-pattern {
                  type boolean;
                  description
                    "Rotate Pattern is enabled";
                }
    
                leaf ping-error-response {
                  type string;
                  description
                    "Error response for each ping, in case of bulk ping";
                }
              }  // list ipv4
    
              container ipv6 {
                presence "ipv6 ping output";
                description "Ping IPv6 response";
                leaf destination {
                  type string;
                  mandatory true;
                  description
                    "Ping destination address or hostname";
                }
    
                leaf repeat-count {
                  type uint64 {
                    range "1..64";
                  }
                  default "5";
                  description
                    "Number of ping packets to be sent out";
                }
    
                leaf data-size {
                  type uint64 {
                    range "36..18024";
                  }
                  default "100";
                  description
                    "Size of ping packet";
                }
    
                leaf timeout {
                  type uint64 {
                    range "0..36";
                  }
                  default "2";
                  description
                    "Timeout in seconds";
                }
    
                leaf interval {
                  type uint32 {
                    range "0..3600";
                  }
                  default "10";
                  description
                    "Ping interval in milli seconds";
                }
    
                leaf pattern {
                  type xr:Hex-integer;
                  description
                    "Pattern of payload data";
                }
    
                leaf sweep {
                  type boolean;
                  description "Sweep is enabled";
                }
    
                leaf sweep-min {
                  type uint32;
                  description
                    "Minimum value of sweep size";
                }
    
                leaf sweep-max {
                  type uint64;
                  description
                    "Maximum value of sweep size";
                }
    
                leaf rotate-pattern {
                  type boolean;
                  description
                    "Rotate Pattern is enabled";
                }
    
                container replies {
                  description
                    "IPv6 ping replies";
                  list reply {
                    key "reply-index";
                    description
                      "IPv6 ping reply";
                    leaf reply-index {
                      type uint64 {
                        range "1..2147483647";
                      }
                      description
                        "Index of the reply list";
                    }
    
                    leaf result {
                      type string;
                      description
                        "Response for each packet";
                    }
                  }  // list reply
                }  // container replies
    
                leaf hits {
                  type uint64;
                  description
                    "Number of packets reach to destination and get reply back";
                }
    
                leaf total {
                  type uint64;
                  description
                    "Total number of packets sent out";
                }
    
                leaf success-rate {
                  type uint64;
                  description
                    "Successful rate of ping";
                }
    
                leaf rtt-min {
                  type uint64;
                  description
                    "Minimum value of Round Trip Time";
                }
    
                leaf rtt-avg {
                  type uint64;
                  description
                    "Average value of Round Trip Time";
                }
    
                leaf rtt-max {
                  type uint64;
                  description
                    "Maximum value of Round Trip Time";
                }
              }  // container ipv6
            }  // container ping-response
          }
        }  // rpc ping
      }  // module Cisco-IOS-XR-ping-act
    

© 2023 YumaWorks, Inc. All rights reserved.