module junos-ex-rpc-services {

    yang-version 1;

    namespace
      "http://yang.juniper.net/junos-ex/rpc/services";

    prefix services;

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

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


    rpc get-probe-results {
      description "Show probe results";
      input {
        leaf owner {
          type string {
            length "1 .. 32";
          }
          description "Name of owner";
        }

        leaf test {
          type string {
            length "1 .. 32";
          }
          description "Name of test";
        }

        leaf source-address {
          type jt:ipaddr;
          description
            "Filter results based on ipv4 or ipv6 source-address";
        }

        leaf target-address {
          type jt:ipaddr;
          description
            "Filter results based on ipv4 or ipv6 target-address";
        }

        leaf dst-interface {
          type union {
            type jt:interface-unit;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description
            "Filter results based on destination-interface";
        }

        leaf status {
          type enumeration {
            enum "PASS" {
              value 0;
              description
                "Dump successful tests";
            }
            enum "FAIL" {
              value 1;
              description
                "Dump failed tests";
            }
          }
          description
            "Filter based on test status PASS or FAIL";
        }

        leaf terse {
          type empty;
          description "Terse output";
        }

        leaf limit {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 4294967295";
            }
          }
          default "100";
          description
            "Dump specified number of results (default is 100)";
        }
      }

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

    rpc get-history-results {
      description "Show history results";
      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 owner {
          type string {
            length "1 .. 32";
          }
          mandatory true;
          description "Name of owner";
        }

        leaf test {
          type string {
            length "1 .. 32";
          }
          description "Name of test";
        }

        leaf since {
          type jt:time;
          description
            "Show history since YYYY-MM-DD.HH:MM:SS";
        }

        leaf source-address {
          type jt:ipaddr;
          description
            "Filter history based on ipv4 or ipv6 source-address";
        }

        leaf target-address {
          type jt:ipaddr;
          description
            "Filter history based on ipv4 or ipv6 target-address";
        }

        leaf dst-interface {
          type union {
            type jt:interface-unit;
            type string {
              pattern "<.*>|$.*";
            }
          }
          description
            "Filter based on destination-interface";
        }

        leaf limit {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32 {
              range "1 .. 4294967295";
            }
          }
          default "100";
          description
            "Dump specified number of results (default is 100)";
        }
      }

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

    rpc get-active-servers {
      description "Show configured servers";
      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml active-servers;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-active-servers

    rpc get-pcef-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
            "Username 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 aci-interface-set-name {
          type string;
          description
            "Display summary for specified ACI interface set";
        }

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

        leaf vlan-id {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint16 {
              range "0 .. 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 string;
          description
            "Identifier of 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 "fwa" {
              value 12;
              description "FWA clients only";
            }
            enum "agf" {
              value 13;
              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";
            }
          }
          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 pcef-subscriber;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-pcef-subscribers

    rpc get-pcef-subscribers-summary {
      description
        "Display pcef 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 port {
          type empty;
          description
            "Display full subscriber port summary";
        }

        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 pcef-subscriber;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-pcef-subscribers-summary

    rpc get-pcef-pic {
      description
        "Show physical interface card information";
      input {
        leaf fpc-slot {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32;
          }
          description "FPC slot number";
        }

        leaf pic-slot {
          type union {
            type string {
              pattern "<.*>|$.*";
            }
            type uint32;
          }
          description "PIC slot number";
        }

        leaf display {
          type enumeration {
            enum "terse" {
              value 0;
              description
                "Display terse output";
            }
          }
          default "terse";
        }
      }

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

    rpc get-uac-policies {
      description
        "Access policies from infranet controller";
      input {
        uses command-forwarding;

        leaf detail {
          type empty;
          description
            "Display detail output";
        }

        leaf identifier {
          type string;
          description
            "Show specified policy information";
        }
      }

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

    rpc get-uac-auth-table {
      description
        "Show authentication table configured from infranet controller";
      input {
        uses command-forwarding;

        leaf detail {
          type empty;
          description
            "Display detail output";
        }

        leaf identifier {
          type string;
          description
            "Show specified authentication entry";
        }

        leaf extended {
          type empty;
          description
            "Show authentication entries with all roles";
        }

        leaf role {
          type string;
          description
            "Show authentication entries matching the role";
        }

        leaf ip {
          type string;
          description
            "Show authentication entries matching the ip";
        }

        leaf user {
          type string;
          description
            "Show authentication entries matching the user";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml uac-auth-table;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-uac-auth-table

    rpc get-uac-status {
      description
        "Show connection status with infranet controller";
      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml uac-status;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-uac-status

    rpc get-uac-counters {
      description
        "Show unified access control(uac) service related counters";
      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml uac-counters;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-uac-counters

    rpc get-services-security-associations-information {
      description
        "Show IPSec security association information";
      input {
        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 service-set {
          type string;
          description
            "Restrict output to one service set";
        }

        leaf hex {
          type empty;
          description
            "Display SPI in hexadecimal format";
        }
      }

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

    rpc get-services-ipsec-statistics-information {
      description "Show IPSec statistics";
      input {
        leaf remote-gw {
          type string;
          description
            "Peer address to use as filter";
        }

        leaf display {
          type enumeration {
            enum "detail" {
              value 0;
              description
                "Display all tunnels";
            }
            enum "brief" {
              value 1;
              description
                "Display accumulated statistics (default)";
            }
          }
          default "brief";
        }

        leaf service-set {
          type string;
          description "Name of service set";
        }
      }

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

    rpc get-ike-services-security-associations-information {
      description
        "Show services IKE security association information";
      input {
        leaf level {
          type enumeration {
            enum "brief" {
              value 0;
              description
                "Show brief output (default)";
            }
            enum "detail" {
              value 1;
              description
                "Show detailed output";
            }
          }
          default "brief";
        }

        leaf peer-address {
          type jt:ipaddr;
          description
            "Name of security association";
        }

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

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ike-security-associations-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ike-services-security-associations-information

    rpc get-ike-services-statistics {
      description
        "Show services IKE security association statistics";
      input {
        leaf peer-address {
          type jt:ipaddr;
          description
            "Name of security association";
        }

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

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml ike-security-associations-statistics;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-ike-services-statistics

    rpc get-fips-pic-status-information {
      description
        "Show FIPS PIC authorization status";
      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml fips-pic-status-information;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-fips-pic-status-information

    rpc get-service-mss-sessions-information {
      description
        "Show mobile subscriber data sessions";
      input {
        leaf imsi {
          type string {
            length "5 .. 15";
          }
          description "IMSI of subscriber";
        }
      }

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

    rpc get-service-hcm-sessions-stats {
      description
        "Show hcm session statistics";
      input {
        leaf imsi {
          type string {
            length "5 .. 15";
          }
          mandatory true;
          description "IMSI of subscriber";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml service-hcm-sessions-stats;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-service-hcm-sessions-stats

    rpc get-service-tdf-sessions-information {
      description
        "Show traffic-detection-function subscriber data sessions";
      input {
        leaf routing-instance {
          type string;
          mandatory true;
          description
            "Name of routing instance";
        }

        leaf ipv4-address {
          type string;
          description
            "Show sessions for matching IPv4 address";
        }

        leaf ipv6-address {
          type string;
          description
            "Show sessions for matching IPv6 address";
        }

        leaf subscriber-name {
          type string;
          description
            "Show sessions for matching Subscriber name";
        }
      }

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

    rpc get-service-tdf-hcm-sessions-stats {
      description
        "Show hcm session statistics";
      input {
        leaf routing-instance {
          type string;
          mandatory true;
          description
            "Name of routing instance";
        }

        leaf ipv4-address {
          type string;
          description
            "Show sessions for matching IPv4 address";
        }

        leaf ipv6-address {
          type string;
          description
            "Show sessions for matching IPv6 address";
        }

        leaf subscriber-name {
          type string;
          description
            "Show sessions for matching Subscriber name";
        }
      }

      output {
        choice output_c {
          leaf output {
            type string;
          }
          anyxml service-tdf-hcm-sessions-stats;
          anyxml multi-routing-engine-results;
        }  // choice output_c
      }
    }  // rpc get-service-tdf-hcm-sessions-stats

    rpc get-global-pcp-statistics-information {
      description
        "Show global PCP statistics";
      input {
        leaf interface {
          type string;
          description
            "Name of adaptive services interface";
        }

        leaf level {
          type enumeration {
            enum "protocol" {
              value 0;
              description
                "Display PCP protocol statistics";
            }
          }
        }
      }

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