module junos-nfx-rpc-ospf {

    yang-version 1;

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

    prefix ospf;

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

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


    rpc get-ospf-overview-information {
      description
        "Show overview of OSPF information";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf tenant {
          type string;
          description
            "Name of tenant, or 'all'";
        }

        leaf verbosity_level {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output (default)";
            }
            enum "extensive" {
              value 1;
              description
                "Display extensive output";
            }
          }
          default "brief";
        }

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }
      }

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

    rpc get-ospf-database-information {
      description
        "Show OSPF link-state database";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf flex-algorithm-id {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "128 .. 255";
            }
          }
          description "Flex Algorithm id";
        }

        leaf tenant {
          type string;
          description
            "Name of tenant, or 'all'";
        }

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

        leaf lsa-type {
          type enumeration {
            enum "router" {
              value 0;
              description
                "Router link-state advertisements";
            }
            enum "network" {
              value 1;
              description
                "Network link-state advertisements";
            }
            enum "netsummary" {
              value 2;
              description
                "Summary network link-state advertisements";
            }
            enum "asbrsummary" {
              value 3;
              description
                "Summary AS boundary router link-state advertisements";
            }
            enum "external" {
              value 4;
              description
                "External link-state advertisements";
            }
            enum "nssa" {
              value 5;
              description
                "Not-so-stubby area link-state advertisements";
            }
            enum "link-local" {
              value 6;
              description
                "Link local link-state advertisements";
            }
            enum "opaque-area" {
              value 7;
              description
                "Opaque area-scope link-state advertisements";
            }
            enum "opaque-as" {
              value 8;
              description
                "Opaque as-scope link-state advertisements";
            }
          }
        }

        leaf area {
          type string;
          default "all";
          description "OSPF area ID";
        }

        leaf lsa-id {
          type string;
          default "all";
          description
            "Link-state advertisement ID";
        }

        leaf advertising-router {
          type string;
          description
            "Router ID of advertising router";
        }

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }
      }

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

    rpc get-ospf-backup-spf-information {
      description
        "Show OSPF backup SPF calculations information";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }

        leaf topology {
          type string;
          description "Name of topology";
        }

        leaf area {
          type jt:areaid;
          description "OSPF area ID";
        }

        leaf no-coverage {
          type empty;
          description
            "Entries with no backup coverage";
        }

        leaf node-id {
          type string;
          description
            "Display nodes matching the node-id";
        }

        leaf verbosity_level {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output (default)";
            }
            enum "detail" {
              value 1;
              description
                "Display detailed output";
            }
          }
          default "brief";
        }
      }

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

    rpc get-ospf-backup-coverage-information {
      description
        "Show OSPF backup coverage";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }

        leaf topology {
          type string;
          description "Name of topology";
        }
      }

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

    rpc get-ospf-backup-neighbor-information {
      description
        "Show OSPF backup neighbors";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }

        leaf topology {
          type string;
          description "Name of topology";
        }

        leaf area {
          type jt:areaid;
          description "OSPF area ID";
        }
      }

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

    rpc get-ospf-backup-lsp-information {
      description
        "Show OSPF MPLS backup LSP information";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ospf-backup-mplsp-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ospf-backup-lsp-information

    rpc get-ospf-interface-information {
      description
        "Show OSPF interface status information";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf tenant {
          type string;
          description
            "Name of tenant, or 'all'";
        }

        leaf verbosity_level {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output (default)";
            }
            enum "detail" {
              value 1;
              description
                "Display detailed output";
            }
            enum "extensive" {
              value 2;
              description
                "Display extensive output";
            }
          }
          default "brief";
        }

        leaf interface-name {
          type string;
          description
            "Name of logical interface";
        }

        leaf area {
          type jt:areaid;
          description "OSPF area ID";
        }

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }
      }

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

    rpc get-ospf-context-id-information {
      description
        "Show OSPF context identifier information";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf verbosity_level {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output (default)";
            }
            enum "detail" {
              value 1;
              description
                "Display detailed output";
            }
          }
          default "brief";
        }

        leaf context-id {
          type string;
          description
            "IP address representing a context identifier";
        }

        leaf area {
          type jt:areaid;
          description "OSPF area ID";
        }

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }
      }

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

    rpc get-ospf-neighbor-information {
      description
        "Show OSPF neighbor status information";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf tenant {
          type string;
          description
            "Name of tenant, or 'all'";
        }

        leaf verbosity_level {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output (default)";
            }
            enum "detail" {
              value 1;
              description
                "Display detailed output";
            }
            enum "extensive" {
              value 2;
              description
                "Display extensive output";
            }
          }
          default "brief";
        }

        leaf interface {
          type string;
          description
            "Name of logical interface";
        }

        leaf area {
          type jt:areaid;
          description "OSPF area ID";
        }

        leaf neighbor {
          type string;
          description
            "IP address or ID of neighbor";
        }

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }
      }

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

    rpc get-ospf-route-information {
      description "Show OSPF routing table";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf flex-algorithm-id {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "128 .. 255";
            }
          }
          description "Flex Algorithm id";
        }

        leaf tenant {
          type string;
          description
            "Name of tenant, or 'all'";
        }

        leaf topology {
          type string;
          description "Name of topology";
        }

        leaf path-type {
          type enumeration {
            enum "intra" {
              value 0;
              description
                "Display intra-area routes";
            }
            enum "inter" {
              value 1;
              description
                "Display inter-area routes";
            }
            enum "extern" {
              value 2;
              description
                "Display external routes";
            }
          }
          description "OSPF path type";
        }

        leaf route-type {
          type enumeration {
            enum "router" {
              value 0;
              description
                "Display routes to all routers";
            }
            enum "abr" {
              value 1;
              description
                "Display routes to area border routers";
            }
            enum "asbr" {
              value 2;
              description
                "Display routes to AS border routers";
            }
            enum "network" {
              value 3;
              description
                "Display routes to networks";
            }
          }
          description "OSPF route type";
        }

        leaf no-backup-coverage {
          type empty;
          description
            "Display routes with no backup coverage";
        }

        leaf destination {
          type jt:ipv4prefix;
          description
            "IP address and optional prefix length of destination";
        }

        leaf verbosity_level {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output (default)";
            }
            enum "detail" {
              value 1;
              description
                "Display detailed output";
            }
            enum "extensive" {
              value 2;
              description
                "Display extensive output";
            }
          }
          default "brief";
        }

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }
      }

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

    rpc get-ospf-statistics-information {
      description "Show OSPF statistics";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf tenant {
          type string;
          description
            "Name of tenant, or 'all'";
        }

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }
      }

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

    rpc get-ospf-io-statistics-information {
      description "Show OSPF I/O statistics";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select
      }

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

    rpc get-ospf-log-information {
      description
        "Show shortest-path-first calculations from OSPF log";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }

        leaf topology {
          type string;
          description "Name of topology";
        }
      }

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

    rpc get-ospf-bgporr-information {
      description
        "Show BGP optimal route-reflection groups";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf topology {
          type string;
          description "Name of topology";
        }

        leaf path-type {
          type enumeration {
            enum "intra" {
              value 0;
              description
                "Display intra-area routes";
            }
            enum "inter" {
              value 1;
              description
                "Display inter-area routes";
            }
            enum "extern" {
              value 2;
              description
                "Display external routes";
            }
          }
          description "OSPF path type";
        }

        leaf route-type {
          type enumeration {
            enum "router" {
              value 0;
              description
                "Display routes to all routers";
            }
            enum "abr" {
              value 1;
              description
                "Display routes to area border routers";
            }
            enum "asbr" {
              value 2;
              description
                "Display routes to AS border routers";
            }
            enum "network" {
              value 3;
              description
                "Display routes to networks";
            }
          }
          description "OSPF route type";
        }

        leaf destination {
          type jt:ipv4prefix;
          description
            "IP address and optional prefix length of destination";
        }

        leaf instance {
          type string;
          description
            "Name of OSPF instance";
        }

        leaf group {
          type string;
          description
            "BGP optimal route-reflection peer group name";
        }

        leaf verbosity_level {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output (default)";
            }
            enum "detail" {
              value 1;
              description
                "Display detailed output";
            }
            enum "extensive" {
              value 2;
              description
                "Display extensive output";
            }
          }
          default "brief";
        }
      }

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

    rpc get-ospf-spring-flex-algorithm-information {
      description
        "Show SPRING flex-algorithm information";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf flex-algorithm-id {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "128 .. 255";
            }
          }
          description "Flex Algorithm id";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ospf-spring-flex-algorithm-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ospf-spring-flex-algorithm-information

    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-ospf