module junos-nfx-rpc-ptp {

    yang-version 1;

    namespace
      "http://yang.juniper.net/junos-nfx/rpc/ptp";

    prefix ptp;

    import junos-common-types {
      prefix jt;
      revision-date "2019-01-01";
    }

    organization "Juniper Networks, Inc.";

    contact "yang-support@juniper.net";

    description
      "Junos RPC YANG module for ptp command(s)";

    revision "2019-01-01" {
      description "Junos: 21.3R1.9";
    }


    rpc get-ptp-global-information {
      description
        "Show PTP related global information";
      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-global-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-global-information

    rpc get-ptp-slave {
      description
        "Show interfaces that receive clock from upstream";
      input {
        leaf interface {
          type string;
          description
            "Name of physical interface";
        }

        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "brief";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-slave;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-slave

    rpc get-ptp-master {
      description
        "Show interfaces that drive clock to downstream slaves";
      input {
        leaf interface {
          type string;
          description
            "Name of physical interface";
        }

        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "brief";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-master;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-master

    rpc get-ptp-delay-metrics-short-term-information {
      description "Display short term data";
      input {
        leaf entries {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 96";
            }
          }
          description
            "No of entries to display";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-delay-metrics-short-term-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-delay-metrics-short-term-information

    rpc get-ptp-delay-metrics-long-term-information {
      description "Display long term data";
      input {
        leaf entry {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 30";
            }
          }
          description
            "Nth last entry to display";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-delay-metrics-long-term-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-delay-metrics-long-term-information

    rpc get-ptp-stateful {
      description
        "Show interfaces that are configured as stateful";
      input {
        leaf interface {
          type string;
          description
            "Name of physical interface";
        }

        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "brief";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-stateful;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-stateful

    rpc get-ptp-port {
      description "Show port stream details";
      input {
        leaf remote-ip {
          type jt:ipaddr;
          description
            "IP address of remote peer";
        }

        leaf ifl {
          type string;
          description
            "IFL name of remote peer";
        }

        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "brief";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-port;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-port

    rpc get-ptp-clock {
      description "Show clock details";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "detail";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-clock;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-clock

    rpc get-ptp-masters-debug {
      description
        "Show All Upstream Masters";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "detail";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-masters-debug;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-masters-debug

    rpc get-ptp-path-trace {
      description "Show path trace details";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "brief";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-path-trace;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-path-trace

    rpc get-ptp-lock-status {
      description
        "Show PTP slave clock locking status";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "brief";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-lock-status;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-lock-status

    rpc get-ptp-statistics {
      description "Show PTP statistics";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "brief";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-statistics;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-statistics

    rpc get-ae-interfaces {
      description "Show AE interfaces";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "brief";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ae-interfaces;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ae-interfaces

    rpc get-ptp-quality-level-mapping {
      description
        "Show PTP clock class to ESMC quality level mapping";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "detail";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-quality-level-mapping;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-quality-level-mapping

    rpc get-last-tod-update {
      description
        "Shows when the last time-of-day update happened";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
          }
          default "brief";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-last-tod-update;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-last-tod-update

    rpc get-ptp-hybrid-status {
      description
        "Show hybrid mode operational status";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "detail";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-hybrid-status;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-hybrid-status

    rpc get-ptp-hybrid-mapping {
      description
        "Show PTP source to Synchronous Ethernet interface mappings";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "detail";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-hybrid-mapping;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-hybrid-mapping

    rpc get-phy-timestamp-enabled-intfs {
      description
        "Show interfaces on which PTP PHY time-stamping feature is enabled";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "brief";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml phy-timestamp-enabled-intfs;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-phy-timestamp-enabled-intfs

    rpc get-ptp-virtual-port {
      description
        "Show ptp virtual port details";
      input {
        leaf verbosity {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output";
            }
            enum "detail" {
              value 1;
              description
                "Display detail output";
            }
          }
          default "detail";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ptp-virtual-port;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ptp-virtual-port

    grouping command-forwarding {
      choice chassis-selector {
        leaf all-chassis {
          type empty;
          description "All chassis";
        }
        leaf all-lcc {
          type empty;
          description "All LCC chassis";
        }
        leaf scc {
          type empty;
          description "SCC";
        }
        leaf sfc {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32;
          }
          description "SFC";
        }
        leaf lcc {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32;
          }
          description "Specific LCC";
        }
        leaf node {
          type string;
          description "Specific node";
        }
        leaf bsys {
          type empty;
          description "Base system";
        }
        leaf gnf {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 10";
            }
          }
          description
            "Specific guest network function";
        }
        leaf all-gnfs {
          type empty;
          description
            "All guest network functions";
        }
        leaf all-system {
          type empty;
          description
            "All system (BSYS and GNFs)";
        }
        leaf server {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "0 .. 1";
            }
          }
          description "Specific server slot";
        }
        leaf all-servers {
          type empty;
          description "All servers";
        }
        leaf vnf {
          type string;
          description
            "Specific virtual-network-function";
        }
        leaf all-vnfs {
          type empty;
          description
            "All virtual-network-functions";
        }
      }  // choice chassis-selector

      choice re-selector {
        leaf re0 {
          type empty;
          description "RE0";
        }
        leaf re1 {
          type empty;
          description "RE1";
        }
        leaf routing-engine {
          type enumeration {
            enum "local" {
              value 0;
              description
                "Local routing engine";
            }
            enum "other" {
              value 1;
              description
                "Other routing engine";
            }
            enum "master" {
              value 2;
              description
                "Master routing engine";
            }
            enum "backup" {
              value 3;
              description
                "Backup routing engine";
            }
            enum "both" {
              value 4;
              description
                "Both routing engines";
            }
          }
          description
            "Specific routing engine";
        }
      }  // choice re-selector

      choice lr-selector {
        leaf logical-system {
          type string;
          description
            "Name of logical system, or 'all'";
        }
      }  // choice lr-selector

      choice tenant-selector {
        leaf tenant {
          type string;
          description
            "Name of tenant, or 'all'";
        }
      }  // choice tenant-selector

      choice vc-selector {
        leaf local {
          type empty;
          description
            "Local virtual chassis member";
        }
        leaf all-members {
          type empty;
          description
            "All virtual chassis members";
        }
        leaf member {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32;
          }
          description
            "Specific virtual chassis member";
        }
      }  // choice vc-selector
    }  // grouping command-forwarding
  }  // module junos-nfx-rpc-ptp