module junos-nfx-rpc-pim {

    yang-version 1;

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

    prefix pim;

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

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


    rpc get-pim-bootstrap-information {
      description
        "Show PIM bootstrap routers";
      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 instance";
        }
      }

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

    rpc get-pim-bidir-df-election-information {
      description
        "Show PIM bidirectional DF election 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 instance";
        }

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

        leaf family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 DF election information";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 DF election information";
            }
          }
          default "inet";
          description "Address family";
        }

        leaf rpa {
          type jt:ipaddr;
          description
            "Rendezvous Point Address";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml pim-bidir-df-election-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-pim-bidir-df-election-information

    rpc get-pim-bidir-df-election-interface-information {
      description
        "Show PIM bidirectional DF election interface 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 instance";
        }

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

        leaf family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 DF election interface information";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 DF election interface information";
            }
          }
          default "inet";
          description "Address family";
        }
      }

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

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

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

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

        leaf family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 interfaces";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 interfaces";
            }
          }
          default "inet";
          description "Address family";
        }
      }

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

    rpc get-pim-join-information {
      description
        "Show PIM join/prune state";
      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 instance";
        }

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

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

        leaf exact {
          type empty;
          description
            "Show only group that matches exactly";
        }

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

        leaf rp {
          type jt:ipprefix;
          description
            "IP address and optional prefix length of rendezvous point";
        }

        leaf sparse {
          type empty;
          description
            "Show only PIM sparse-mode entries (including SSM)";
        }

        leaf dense {
          type empty;
          description
            "Show only PIM dense-mode entries";
        }

        leaf bidirectional {
          type empty;
          description
            "Show only bidirectional PIM entries";
        }

        leaf star-g {
          type empty;
          description
            "Show only *,G entries";
        }

        leaf sg {
          type empty;
          description
            "Show only S,G entries";
        }

        leaf resolve-mvpn-neighbor {
          type empty;
          description
            "Display BGP-MVPN neighbor";
        }

        leaf downstream-count {
          type empty;
          description
            "Display downstream count instead of list";
        }

        leaf family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 join/prune state";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 join/prune state";
            }
          }
          default "inet";
          description "Address family";
        }
      }

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

    rpc get-pim-mvpn-information {
      description "Show PIM MVPN instances";
      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 pim-mvpn-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-pim-mvpn-information

    rpc get-pim-neighbors-information {
      description "Show PIM 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 instance";
        }

        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 family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 neighbors";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 neighbors";
            }
          }
          default "inet";
          description "Address family";
        }
      }

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

    rpc get-pim-rps-information {
      description
        "Show PIM rendezvous points";
      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 instance";
        }

        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 group-address {
          type jt:ipaddr;
          description "IP address of group";
        }

        leaf family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 rendezvous points";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 rendezvous points";
            }
          }
          default "inet";
          description "Address family";
        }
      }

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

    rpc get-pim-source-information {
      description
        "Show the PIM source RPF state";
      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 instance";
        }

        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 resolve-mvpn-neighbor {
          type empty;
          description
            "Display BGP-MVPN neighbor";
        }

        leaf source {
          type jt:ipprefix;
          description
            "IP address and optional prefix length of source RPFs";
        }

        leaf family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 PIM source RPF state";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 PIM source RPF state";
            }
          }
          default "inet";
          description "Address family";
        }
      }

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

    rpc get-pim-statistics-information {
      description "Show PIM statistics";
      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 instance";
        }

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

        leaf family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 PIM statistics";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 PIM statistics";
            }
          }
          default "inet";
          description "Address family";
        }
      }

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

    rpc get-pim-mdt-information {
      description
        "Show state of PIM multicast data tunnels";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf direction {
          type enumeration {
            enum "outgoing" {
              value 0;
              description
                "Display outgoing multicast data tunnels";
            }
            enum "incoming" {
              value 1;
              description
                "Display incoming multicast data tunnels";
            }
          }
        }

        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";
            }
          }
          default "brief";
        }

        leaf range {
          type jt:ipprefix;
          description
            "IP address and optional prefix length of group";
        }

        leaf family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 MDT information";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 MDT information";
            }
          }
          default "inet";
          description "Address family";
        }

        leaf instance {
          type string;
          mandatory true;
          description "Name of PIM instance";
        }
      }

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

    rpc get-pim-data-mdt-limit {
      description
        "Show received PIM data MDT limit";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 MDT limit information";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 MDT limit information";
            }
          }
          default "inet";
          description "Address family";
        }

        leaf instance {
          type string;
          mandatory true;
          description "Name of PIM instance";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml pim-data-mdt-limit;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-pim-data-mdt-limit

    rpc get-pim-data-mdt-join-information {
      description
        "Show received PIM data-mdt-joins";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 MDT join information";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 MDT join information";
            }
          }
          default "inet";
          description "Address family";
        }

        leaf instance {
          type string;
          mandatory true;
          description "Name of PIM instance";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml pim-data-mdt-join-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-pim-data-mdt-join-information

    rpc get-pim-snooping-interfaces-information {
      description
        "Show PIM snooping interfaces";
      input {
        leaf logical-system {
          type string;
          description
            "Name of logical system, or 'all'";
        }

        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 interface {
          type string;
          description "Name of interface";
        }

        leaf vlan-id {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "0 .. 4094";
            }
          }
          description
            "VLAN ID for a learning domain";
        }

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

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

    rpc get-pim-snooping-join-information {
      description "Show PIM snooping join";
      input {
        leaf logical-system {
          type string;
          description
            "Name of logical system, 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 group {
          type jt:ipv4prefix;
          description
            "IP address range for group";
        }

        leaf vlan-id {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "0 .. 4094";
            }
          }
          description
            "VLAN ID for a learning domain";
        }

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

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

    rpc get-pim-snooping-neighbors-information {
      description
        "Show PIM snooping neighbors";
      input {
        leaf logical-system {
          type string;
          description
            "Name of logical system, or 'all'";
        }

        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 interface {
          type string;
          description "Name of interface";
        }

        leaf vlan-id {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "0 .. 4094";
            }
          }
          description
            "VLAN ID for a learning domain";
        }

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

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

    rpc get-pim-snooping-statistics-information {
      description
        "Show PIM snooping statistics";
      input {
        leaf logical-system {
          type string;
          description
            "Name of logical system, or 'all'";
        }

        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 interface {
          type string;
          description "Name of interface";
        }

        leaf vlan-id {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "0 .. 4094";
            }
          }
          description
            "VLAN ID for a learning domain";
        }

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

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml pim-snooping-statistics-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-pim-snooping-statistics-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-pim