module junos-nfx-rpc-multicast {

    yang-version 1;

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

    prefix multicast;

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

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


    rpc get-mc-fwd-cache-information {
      description
        "Show multicast forwarding cache 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 family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 information";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 information";
            }
          }
          description "Address Family";
        }
      }

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

    rpc get-multicast-router-information {
      description
        "Request multicast router information";
      input {
        leaf host {
          type string;
          mandatory true;
          description
            "Hostname or address of remote host";
        }
      }

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

    rpc get-multicast-route-information {
      description
        "Show the multicast routing table";
      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 mode {
          type enumeration {
            enum "all" {
              value 0;
              description
                "Display all route entries";
            }
            enum "active" {
              value 1;
              description
                "Display active route entries";
            }
            enum "inactive" {
              value 2;
              description
                "Display inactive route entries";
            }
          }
          default "all";
        }

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

        leaf table {
          type string;
          status deprecated;
          description
            "Entries in a particular routing table";
        }

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

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

        leaf regexp {
          type string;
          description
            "Regular expression for session to match";
        }

        leaf display-tunnel-name {
          type empty;
          description
            "Display provider tunnel name instead of branch information";
        }

        leaf display-origin-protocol {
          type empty;
          description
            "Display originating protocol instead of upstream protocol";
        }

        leaf oif-count {
          type empty;
          description
            "Display outgoing interface count instead of list";
        }
      }

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

    rpc get-multicast-next-hops-information {
      description
        "Show the multicast next-hop table";
      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 "terse" {
              value 0;
              description
                "Display terse output";
            }
            enum "brief" {
              value 1;
              description
                "Display brief output (default)";
            }
            enum "detail" {
              value 2;
              description
                "Display detailed output";
            }
          }
          default "brief";
        }

        leaf identifier {
          type union {
            type uint32;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "ID of next hop";
        }

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

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

    rpc get-satellite-control-next-hop {
      description
        "Show satellite multicast unicast next-hops";
      input {
        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 satellite-control-next-hop {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-satellite-control-next-hop

    rpc get-multicast-rpf-information {
      description
        "Show reverse-path forwarding (RPF) source network 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 "summary" {
              value 0;
              description
                "Display summary output";
            }
          }
        }

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

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

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

    rpc get-multicast-scope-information {
      description
        "Show administratively scoped multicast 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 family {
          type enumeration {
            enum "inet" {
              value 0;
              description
                "Display IPv4 information";
            }
            enum "inet6" {
              value 1;
              description
                "Display IPv6 information";
            }
          }
          default "inet";
          description "Address family";
        }
      }

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

    rpc get-multicast-sessions-information {
      description
        "Show announced multicast sessions";
      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";
            }
            enum "extensive" {
              value 2;
              description
                "Display extensive output";
            }
          }
          default "brief";
        }

        leaf regexp {
          type string;
          description
            "Regular expression for sessions to match";
        }
      }

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

    rpc get-multicast-statistics-information {
      description
        "Show multicast 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 statistics for IPv4 ";
            }
            enum "inet6" {
              value 1;
              description
                "Display statistics for IPv6 ";
            }
          }
          default "inet";
          description "Address family";
        }
      }

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

    rpc get-satellite-control-statistics {
      description
        "Show satellite multicast statistics";
      input {
        leaf verbosity_level {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output (default)";
            }
            enum "detail" {
              value 1;
              description
                "Display detailed output";
            }
          }
          default "detail";
        }
      }

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

    rpc get-multicast-tunnels-information {
      status deprecated;
      description
        "Show multicast tunnel 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 multicast-tunnels-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-multicast-tunnels-information

    rpc get-multicast-usage-information {
      description
        "Show multicast usage 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 "brief";
        }

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

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

    rpc get-multicast-flow-maps-information {
      description
        "Show configured flow maps";
      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";
        }
      }

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

    rpc get-multicast-interface-information {
      description
        "Show configured interfaces";
      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 multicast-interface-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-multicast-interface-information

    rpc get-multicast-pim-to-igmp-proxy-information {
      description
        "Show pim-to-igmp-proxy 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";
        }
      }

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

    rpc get-multicast-pim-to-mld-proxy-information {
      description
        "Show pim-to-mld-proxy 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";
        }
      }

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

    rpc get-multicast-backup-pe-groups-information {
      description "Show backup PE groups";
      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 multicast-backup-pe-groups-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-multicast-backup-pe-groups-information

    rpc get-multicast-backup-pe-group-information {
      description
        "Show information for specified group";
      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 group_name {
          type string;
          mandatory true;
          description "Name of the group";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml multicast-backup-pe-groups-information {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-multicast-backup-pe-group-information

    rpc get-multicast-backup-pe-address-information {
      description
        "Show groups a PE address is associated with";
      input {
        choice daemon-select {
          leaf logical-system {
            type string;
            description
              "Name of logical system, or 'all'";
          }
        }  // choice daemon-select

        leaf pe_address {
          type jt:ipaddr;
          mandatory true;
          description "IP address of the PE";
        }
      }

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

    rpc get-multicast-snooping-route-information {
      description
        "Show the multicast snooping routing table";
      input {
        leaf logical-system {
          type string;
          description
            "Name of logical system, or 'all'";
        }

        leaf mode {
          type enumeration {
            enum "all" {
              value 0;
              description
                "Display all route entries";
            }
            enum "active" {
              value 1;
              description
                "Display active route entries";
            }
            enum "inactive" {
              value 2;
              description
                "Display inactive route entries";
            }
            enum "control" {
              value 3;
              description
                "Display control route entries";
            }
            enum "data" {
              value 4;
              description
                "Display data route entries";
            }
          }
          default "data";
        }

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

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

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

        leaf mesh-group {
          type string;
          description "Name of a mesh-group";
        }

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

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

        leaf regexp {
          type string;
          description
            "Regular expression for session to match";
        }

        leaf bridge-domain {
          type string;
          description
            "Name of bridge-domain";
        }

        leaf vlan {
          type string;
          description "Name of VLAN";
        }

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

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

    rpc get-satellite-control-multicast {
      description
        "Show the satellite multicast snooping information";
      input {
        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 vswitch-name {
          type string;
          description "Virtual switch name";
        }

        leaf bridge-domain-name {
          type string;
          description "Bridge domain name";
        }

        leaf vlan-name {
          type string;
          description "Vlan name";
        }

        leaf group {
          type jt:ipaddr;
          description
            "Multicast Group Address";
        }

        leaf source {
          type jt:ipaddr;
          description "Source Address";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml satellite-control-multicast {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-satellite-control-multicast

    rpc get-multicast-snooping-next-hops-information {
      description
        "Show the multicast next-hop snooping table";
      input {
        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 identifier {
          type union {
            type uint32;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "ID of next hop";
        }

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

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

    rpc get-satellite-control-indirect-next-hop {
      description
        "Show satellite multicast next-hops";
      input {
        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 nexthop-id {
          type union {
            type int32;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "Next-hop ID";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml satellite-control-indirect-next-hop {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-satellite-control-indirect-next-hop

    rpc get-satellite-control-ecid {
      description
        "Show the satellite multicast ECID mapping database";
      input {
        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 device-id {
          type union {
            type int32;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "Device ID";
        }

        leaf ecid {
          type union {
            type int32;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "ECID";
        }

        leaf reference-id {
          type union {
            type int32;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description "Reference ID";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml satellite-control-ecid {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-satellite-control-ecid

    rpc get-satellite-control-summary {
      description
        "Show satellite multicast summary information";
      input {
        leaf verbosity_level {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Display brief output (default)";
            }
            enum "detail" {
              value 1;
              description
                "Display detailed output";
            }
          }
          default "detail";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml satellite-control-summary {
          }
          anyxml multi-routing-engine-results {
          }
        }  // choice output_c
      }
    }  // rpc get-satellite-control-summary
  }  // module junos-nfx-rpc-multicast