module junos-es-rpc-oam {

    yang-version 1;

    namespace
      "http://yang.juniper.net/junos-es/rpc/oam";

    prefix oam;

    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 oam command(s)";

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


    rpc get-lfmd-information {
      description
        "Show link-fault-management information";
      input {
        leaf level {
          type enumeration {
            enum "detail" {
              value 0;
              description
                "Display detailed data";
            }
            enum "brief" {
              value 1;
              description
                "Display brief data (default)";
            }
          }
          default "brief";
        }

        leaf interface-name {
          type union {
            type jt:interface-device;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description
            "Name of physical interface";
        }
      }

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

    rpc get-cfm-adjacency-information {
      description
        "Show connectivity-fault-management adjacencies";
      input {
        leaf interface-name {
          type union {
            type jt:interface-name;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "Name of interface";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml cfm-adjacency-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-cfm-adjacency-information

    rpc get-cfm-interfaces-information {
      description
        "Show Ethernet OAM information for interface";
      input {
        leaf interface-name {
          type string;
          description "Name of interface";
        }

        leaf vlan {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type int32 {
              range "1 .. 4094";
            }
          }
          description "Trunk interface VLAN";
        }

        leaf level {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type int32 {
              range "0 .. 7";
            }
          }
          description
            "Level value for maintenance domain";
        }

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

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

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

    rpc get-cfm-mep-database {
      description
        "Show Ethernet OAM maintenance endpoint database information";
      input {
        leaf maintenance-domain {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance domain";
        }

        leaf maintenance-association {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance association";
        }

        leaf local-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for local maintenance endpoint";
        }

        leaf remote-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for remote maintenance endpoint";
        }

        leaf extensive {
          type empty;
          description
            "Display complete information for given remote mep";
        }

        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml cfm-mep-database {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-cfm-mep-database

    rpc get-cfm-forwarding-state-instance-information {
      description
        "Show Ethernet OAM state for a forwarding instance";
      input {
        leaf instance-name {
          type string;
          default "all";
          description
            "Show information for a particular routing instance";
        }

        leaf bridge-domain {
          type string;
          default "all";
          description
            "Show information for a particular bridge domain";
        }

        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select

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

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml cfm-flood-instance-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-cfm-forwarding-state-instance-information

    rpc get-cfm-forwarding-state-interface-information {
      description
        "Show Ethernet OAM state for an interface";
      input {
        leaf interface-name {
          type union {
            type jt:interface-unit;
            type string {
              pattern "<.*>|$.*";
            }
          }
          default "all";
          description
            "Display information for this logical interface";
        }

        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select

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

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml cfm-flood-interface-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-cfm-forwarding-state-interface-information

    rpc get-cfm-linktrace-path-database {
      description
        "Display the linktrace path-database for a remote host";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select

        leaf maintenance-domain {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance domain";
        }

        leaf maintenance-association {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance association";
        }

        leaf host {
          type jt:mac-unicast;
          mandatory true;
          description
            "MAC address of remote host in xx:xx:xx:xx:xx:xx format";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml cfm-linktrace-path-database {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-cfm-linktrace-path-database

    rpc get-cfm-mip-information {
      description "Display MIP information";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select

        leaf instance-name {
          type string;
          default "all";
          description
            "Show information for a particular routing instance";
        }

        leaf bridge-domain {
          type string;
          default "all";
          description
            "Show information for a particular bridge domain";
        }

        leaf interface-name {
          type string;
          default "all";
          description
            "Display information for this logical interface";
        }

        leaf vlan {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type int32 {
              range "1 .. 4094";
            }
          }
          description
            "Show information for a particular VLAN within a bridge domain";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml cfm-mip-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-cfm-mip-information

    rpc get-cfm-mep-statistics {
      description
        "Show Ethernet OAM maintenance endpoint statistics information";
      input {
        leaf maintenance-domain {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance domain";
        }

        leaf maintenance-association {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance association";
        }

        leaf local-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for local maintenance endpoint";
        }

        leaf remote-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for remote maintenance endpoint";
        }

        leaf count {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 100";
            }
          }
          description
            "Number of statistics per maintenance endpoint";
        }

        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select
      }

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

    rpc get-cfm-delay-statistics {
      description
        "Show Ethernet OAM maintenance endpoint delay statistics information";
      input {
        leaf maintenance-domain {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance domain";
        }

        leaf maintenance-association {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance association";
        }

        leaf local-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for local maintenance endpoint";
        }

        leaf remote-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for remote maintenance endpoint";
        }

        leaf count {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 100";
            }
          }
          description
            "Number of delay statistics per maintenance endpoint";
        }

        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select
      }

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

    rpc get-cfm-loss-statistics {
      description
        "Show Ethernet OAM maintenance endpoint loss statistics information";
      input {
        leaf maintenance-domain {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance domain";
        }

        leaf maintenance-association {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance association";
        }

        leaf local-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for local maintenance endpoint";
        }

        leaf remote-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for remote maintenance endpoint";
        }

        leaf count {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 100";
            }
          }
          description
            "Number of loss statistics per maintenance endpoint";
        }

        leaf session-id {
          type union {
            type uint32;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description
            "Ethernet loss measurement client session id";
        }
      }

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

    rpc get-cfm-slm-statistics {
      description
        "Show Ethernet OAM maintenance endpoint eth-slm statistics information";
      input {
        leaf maintenance-domain {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance domain";
        }

        leaf maintenance-association {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance association";
        }

        leaf count {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 100";
            }
          }
          description
            "Number of synthetic loss statistics per maintenance endpoint";
        }

        leaf local-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for local maintenance endpoint";
        }

        leaf remote-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for remote maintenance endpoint";
        }

        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select
      }

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

    rpc get-cfm-policer-information {
      description
        "Show Ethernet OAM policer information";
      input {
        leaf maintenance-domain {
          type string {
            length "1 .. 45";
          }
          description
            "Name of maintenance domain";
        }

        leaf maintenance-association {
          type string {
            length "1 .. 45";
          }
          description
            "Name of maintenance association";
        }

        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml cfm-policer {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-cfm-policer-information

    rpc get-cfm-iterator-statistics {
      description
        "Show Ethernet OAM SLA iterator statistics information";
      input {
        leaf sla-iterator {
          type string;
          mandatory true;
          description
            "Name of the iterator profile";
        }

        leaf maintenance-domain {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance domain";
        }

        leaf maintenance-association {
          type string {
            length "1 .. 45";
          }
          mandatory true;
          description
            "Name of maintenance association";
        }

        leaf local-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          mandatory true;
          description
            "Identifier for local maintenance endpoint";
        }

        leaf remote-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type int32 {
              range "1 .. 8191";
            }
          }
          mandatory true;
          description
            "MEP identifier of remote host";
        }

        leaf current-statistics-type {
          type enumeration {
            enum "loss-measurement" {
              value 0;
              description
                "Show current Frame Loss measurements";
            }
            enum "availability" {
              value 1;
              description
                "Show current Availability measurements";
            }
            enum "delay-measurement" {
              value 2;
              description
                "Show current Delay measurement";
            }
            enum "bin" {
              value 3;
              description
                "Show current Delay measurement bin";
            }
            enum "flap-trap-statistics" {
              value 4;
              description
                "Show Flap Trap Statistics ";
            }
          }
        }

        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select

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

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

    rpc get-cfm-cfmman-conn-statistics {
      description
        "Show Ethernet OAM cfmman connection statistics information";
      input {
        leaf fpc-slot {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "0 .. 80";
            }
          }
          description "Fpc slot number";
        }

        leaf extensive {
          type empty;
          description
            "Display stats based on RPC types";
        }

        leaf summary {
          type empty;
          description
            "Display global statistics";
        }
      }

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

    rpc get-cfm-iterator-history {
      description
        "Show Ethernet OAM SLA iterator 5 minutes history information";
      input {
        leaf sla-iterator {
          type string;
          description
            "Name of the iterator profile";
        }

        leaf maintenance-domain {
          type string {
            length "1 .. 45";
          }
          description
            "Name of maintenance domain";
        }

        leaf maintenance-association {
          type string {
            length "1 .. 45";
          }
          description
            "Name of maintenance association";
        }

        leaf local-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 8191";
            }
          }
          description
            "Identifier for local maintenance endpoint";
        }

        leaf remote-mep {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type int32 {
              range "1 .. 8191";
            }
          }
          description
            "MEP identifier of remote host";
        }

        leaf history-statistics-type {
          type enumeration {
            enum "delay-measurement" {
              value 0;
              description
                "Show history Delay measurements";
            }
            enum "bin" {
              value 1;
              description
                "History Delay measurement bin";
            }
            enum "loss-measurement" {
              value 2;
              description
                "History Frame Loss measurements";
            }
            enum "availability" {
              value 3;
              description
                "History Availability for SLM/LM measurements";
            }
          }
        }

        leaf record-number {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type int32 {
              range "1 .. 32";
            }
          }
          description
            "History record number";
        }

        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system";
          }
        }  // choice daemon-select
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml cfm-iterator-history {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-cfm-iterator-history

    rpc get-evc-infromation {
      description
        "Show ethernet virtual circuit information";
      input {
        leaf evc-id {
          type string;
          description "EVC identifier";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml elmi-evc-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-evc-infromation

    rpc get-elmi-information {
      description
        "Show ethernet local management information";
      input {
        leaf interface {
          type union {
            type jt:interface-device;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "Name of interface";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml elmi-interface-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-elmi-information

    rpc get-elmi-statistics {
      description
        "Show ethernet local management statistics";
      input {
        leaf interface {
          type union {
            type jt:interface-device;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "Name of interface";
        }
      }

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

    rpc get-fnp-interface-information {
      description
        "Show FNP interface information";
      input {
        leaf interface {
          type union {
            type jt:interface-unit;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "Name of interface";
        }

        leaf routing-instance {
          type string;
          description
            "Name of routing instance";
        }

        leaf vlan {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type int32 {
              range "1 .. 4094";
            }
          }
          description "VLAN ID";
        }

        leaf all {
          type empty;
          description "Show all interfaces";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml fnp-interface-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-fnp-interface-information

    rpc get-fnp-status {
      description "Show FNP status";
      input {
        leaf interface {
          type union {
            type jt:interface-device;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "Name of interface";
        }

        leaf routing-instance {
          type string;
          description
            "Name of routing instance";
        }
      }

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

    rpc get-fnp-messages {
      description "Show active FNP messages";
      input {
        leaf interface {
          type union {
            type jt:interface-unit;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "Name of interface";
        }

        leaf routing-instance {
          type string;
          description
            "Name of routing instance";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml fnp-messages-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-fnp-messages

    rpc get-gre-ka-information {
      description
        "Show GRE Keepalive information";
      input {
        leaf interface-name {
          type string;
          default "all";
          description
            "Display information for this logical interface";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml oamd-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-gre-ka-information
  }  // module junos-es-rpc-oam