module junos-nfx-rpc-subscribers {

    yang-version 1;

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

    prefix subscribers;

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

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


    rpc get-subscribers {
      description
        "Show subscriber information";
      input {
        leaf address {
          type string;
          description
            "IPv4 or IPv6 address of subscriber";
        }

        leaf interface {
          type union {
            type jt:interface-wildcard;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description
            "Interface name, or with wildcards (e.g. fe-0/0/*, fe-0/*/*)";
        }

        leaf physical-interface {
          type union {
            type jt:interface-wildcard;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description
            "Physical Interface name";
        }

        leaf user-name {
          type string;
          description
            "User name of subscriber";
        }

        leaf logical-system {
          type string;
          description
            "Logical system where subscriber resides";
        }

        leaf routing-instance {
          type string;
          description
            "Routing instance where subscriber resides";
        }

        leaf profile-name {
          type string {
            length "1 .. 80";
          }
          description
            "Profile with which subscriber has been activated";
        }

        leaf agent-circuit-identifier {
          type string;
          description
            "Display summary for specified agent circuit identifier";
        }

        leaf agent-remote-identifier {
          type string;
          description
            "Display summary for specified agent remote identifier";
        }

        leaf aci-interface-set-name {
          type string;
          description
            "Display summary for specified ACI interface set";
        }

        leaf aggregation-interface-set-name {
          type string;
          description
            "Display summary for specified aggregation interface set";
        }

        leaf stacked-vlan-id {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint16 {
              range "1 .. 4094";
            }
          }
          description
            "Stacked VLAN identifier of subscriber";
        }

        leaf vlan-id {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint16 {
              range "1 .. 4094";
            }
          }
          description
            "VLAN identifier of subscriber";
        }

        leaf vpi {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint16 {
              range "0 .. 255";
            }
          }
          description
            "ATM VPI of subscriber";
        }

        leaf vci {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint16 {
              range "0 .. 65535";
            }
          }
          description
            "ATM VCI of subscriber";
        }

        leaf id {
          type union {
            type uint64;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description
            "Identifier of subscriber";
        }

        leaf accounting-statistics {
          type empty;
          description
            "Display accounting statistics for subscriber";
        }

        leaf mac-address {
          type jt:mac-addr;
          description
            "MAC address of subscriber";
        }

        leaf client-type {
          type enumeration {
            enum "dhcp" {
              value 0;
              description
                "DHCP clients only";
            }
            enum "vlan" {
              value 1;
              description
                "VLAN clients only";
            }
            enum "ppp" {
              value 2;
              description "PPP clients only";
            }
            enum "pppoe" {
              value 3;
              description
                "PPPoE clients only";
            }
            enum "l2tp" {
              value 4;
              description
                "L2TP clients only";
            }
            enum "static" {
              value 5;
              description
                "Static clients only";
            }
            enum "vpls-pw" {
              value 6;
              description
                "VPLS-PW clients only";
            }
            enum "mlppp" {
              value 7;
              description
                "MLPPP clients only";
            }
            enum "xauth" {
              value 8;
              description
                "XAuth clients only";
            }
            enum "fwauth" {
              value 9;
              description
                "FwAuth clients only";
            }
            enum "dot1x" {
              value 10;
              description
                "Dot1x clients only";
            }
            enum "essm" {
              value 11;
              description
                "ESSM clients only";
            }
            enum "l2ckt-pw" {
              value 12;
              description
                "L2CKT-PW clients only";
            }
            enum "gre" {
              value 13;
              description "GRE clients only";
            }
            enum "vlan-oob" {
              value 14;
              description
                "VLAN out-of-band clients only";
            }
            enum "dyn-ip" {
              value 15;
              description
                "Dynamic IP clients only";
            }
            enum "hag-tunnel" {
              value 16;
              description
                "HAG tunnel clients only";
            }
            enum "hag-bundle" {
              value 17;
              description
                "HAG bundle clients only";
            }
            enum "fixed-wireless-access" {
              value 18;
              description
                "Fixed Wireless Access clients only";
            }
            enum "agf" {
              value 19;
              description "AGF clients only";
            }
          }
          description
            "Client type of subscriber";
        }

        leaf subscriber-state {
          type enumeration {
            enum "init" {
              value 0;
              description "INIT state only";
            }
            enum "configured" {
              value 1;
              description
                "CONFIGURED state only";
            }
            enum "active" {
              value 2;
              description
                "ACTIVE state only";
            }
            enum "terminating" {
              value 3;
              description
                "TERMINATING state only";
            }
            enum "terminated" {
              value 4;
              description
                "TERMINATED state only";
            }
          }
          description "State of subscriber";
        }

        leaf display {
          type enumeration {
            enum "terse" {
              value 0;
              description
                "Display terse output";
            }
            enum "detail" {
              value 1;
              description
                "Display detailed output";
            }
            enum "extensive" {
              value 2;
              description
                "Display extensive output";
            }
            enum "count" {
              value 3;
              description
                "Display number of subscribers";
            }
          }
          default "terse";
        }
      }

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

    rpc get-subscribers-summary {
      description
        "Display subscriber summary";
      input {
        leaf logical-system {
          type string;
          description
            "Display summary for specified logical system";
        }

        leaf routing-instance {
          type string;
          description
            "Display summary for specified routing instance";
        }

        leaf physical-interface {
          type union {
            type jt:interface-wildcard;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description
            "Physical Interface name";
        }

        leaf pic {
          type empty;
          description
            "Display full subscriber pic summary";
        }

        leaf slot {
          type empty;
          description
            "Display full subscriber slot summary";
        }

        leaf all {
          type empty;
          description
            "Display full subscriber summary";
        }
      }

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

    rpc get-subscribers-port-summary {
      description
        "Display full subscriber port summary";
      input {
        leaf extensive {
          type empty;
          description
            "Display full subscriber port detail";
        }
      }

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

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