junos-nfx-rpc-snmp

Junos RPC YANG module for snmp command(s)

  • Version: 2019-01-01

    junos-nfx-rpc-snmp@2019-01-01


    
      module junos-nfx-rpc-snmp {
    
        yang-version 1;
    
        namespace
          "http://yang.juniper.net/junos-nfx/rpc/snmp";
    
        prefix snmp;
    
        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 snmp command(s)";
    
        revision "2019-01-01" {
          description "Junos: 21.3R1.9";
        }
    
    
        rpc get-snmp-object {
          description "Get SNMP object value";
          input {
            leaf format {
              type enumeration {
                enum "decimal" {
                  value 0;
                  description
                    "Decimal format (default)";
                }
                enum "ascii" {
                  value 1;
                  description
                    "Convert string indices to 'ascii-keys' representation";
                }
                enum "hex" {
                  value 2;
                  description
                    "Shows value part in hexadecimal format";
                }
              }
              default "decimal";
            }
    
            leaf snmp-object-name {
              type string;
              mandatory true;
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-object-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-object
    
        rpc next-snmp-object {
          description
            "Get next SNMP object value";
          input {
            leaf format {
              type enumeration {
                enum "decimal" {
                  value 0;
                  description
                    "Decimal format (default)";
                }
                enum "ascii" {
                  value 1;
                  description
                    "Convert string indices to 'ascii-keys' representation";
                }
                enum "hex" {
                  value 2;
                  description
                    "Shows value part in hexadecimal format";
                }
              }
              default "decimal";
            }
    
            leaf snmp-object-name {
              type string;
              mandatory true;
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-object-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc next-snmp-object
    
        rpc walk-snmp-object {
          description "Walk SNMP object values";
          input {
            leaf format {
              type enumeration {
                enum "decimal" {
                  value 0;
                  description
                    "Decimal format (default)";
                }
                enum "ascii" {
                  value 1;
                  description
                    "Convert string indices to 'ascii-keys' representation";
                }
                enum "hex" {
                  value 2;
                  description
                    "Shows value part in hexadecimal format";
                }
              }
              default "decimal";
            }
    
            leaf snmp-object-name {
              type string;
              mandatory true;
              description
                "Requested SNMP object names";
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-object-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc walk-snmp-object
    
        rpc get-snmp-information {
          description "Show SNMP statistics";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-statistics;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-information
    
        rpc get-snmp-subagent-statistics {
          description
            "Show statistics for all SNMP subagents";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-subagent-statistics;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-subagent-statistics
    
        rpc get-snmp-stats-response-statistics-information {
          description
            "Show mib2d's statistics for the stats responses from kernel/PFE";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-stats-response-statistics;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-stats-response-statistics-information
    
        rpc get-rmon-information {
          description
            "Show remote monitoring information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml rmon-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-rmon-information
    
        rpc get-rmon-history-information {
          description "Show RMON history";
          input {
            leaf index {
              type union {
                type int32;
                type string {
                  pattern "<.*>|$.*";
                }
              }
            }
    
            leaf sample-index {
              type union {
                type int32;
                type string {
                  pattern "<.*>|$.*";
                }
              }
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml rmon-history-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-rmon-history-information
    
        rpc get-rmon-alarm-information {
          description "Show RMON alarms";
          input {
            leaf 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 rmon-alarm-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-rmon-alarm-information
    
        rpc get-rmon-event-information {
          description "Show RMON events";
          input {
            leaf 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 rmon-event-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-rmon-event-information
    
        rpc get-rmon-log-information {
          description
            "Show rmon monitoring logs";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml rmon-log-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-rmon-log-information
    
        rpc get-health-monitor-information {
          description
            "Show health-monitoring information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml health-monitor-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-health-monitor-information
    
        rpc get-health-monitor-alarm-information {
          description
            "Show health-monitor alarms";
          input {
            leaf 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 rmon-alarm-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-health-monitor-alarm-information
    
        rpc get-health-monitor-log-information {
          description
            "Show health-monitoring logs";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml rmon-log-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-health-monitor-log-information
    
        rpc get-health-monitor-routing-engine-information {
          description
            "Show routing-engine health monitoring information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml health-monitor-routing-engine-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-health-monitor-routing-engine-information
    
        rpc get-health-monitor-routing-engine-history {
          description
            "Show routing-engine resource usage history";
          input {
            leaf level {
              type enumeration {
                enum "brief" {
                  value 0;
                  description
                    "Display brief output (default)";
                }
                enum "extensive" {
                  value 1;
                  description
                    "Display extensive output";
                }
                enum "terse" {
                  value 2;
                  description
                    "Display terse output";
                }
              }
              default "brief";
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml hm-log-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-health-monitor-routing-engine-history
    
        rpc get-routing-engine-cpu-history {
          description "Show cpu usage history";
          input {
            leaf level {
              type enumeration {
                enum "brief" {
                  value 0;
                  description
                    "Display brief output (default)";
                }
                enum "extensive" {
                  value 1;
                  description
                    "Display extensive output";
                }
                enum "terse" {
                  value 2;
                  description
                    "Display terse output";
                }
              }
              default "brief";
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml hm-log-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-routing-engine-cpu-history
    
        rpc get-routing-engine-memory-history {
          description
            "Show memory usage history";
          input {
            leaf level {
              type enumeration {
                enum "brief" {
                  value 0;
                  description
                    "Display brief output (default)";
                }
                enum "extensive" {
                  value 1;
                  description
                    "Display extensive output";
                }
                enum "terse" {
                  value 2;
                  description
                    "Display terse output";
                }
              }
              default "brief";
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml hm-log-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-routing-engine-memory-history
    
        rpc get-routing-engine-fd-history {
          description
            "Show file descriptor usage history";
          input {
            leaf level {
              type enumeration {
                enum "brief" {
                  value 0;
                  description
                    "Display brief output (default)";
                }
                enum "extensive" {
                  value 1;
                  description
                    "Display extensive output";
                }
                enum "terse" {
                  value 2;
                  description
                    "Display terse output";
                }
              }
              default "brief";
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml hm-log-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-routing-engine-fd-history
    
        rpc get-routing-engine-pcount-history {
          description
            "Show process count usage history";
          input {
            leaf level {
              type enumeration {
                enum "brief" {
                  value 0;
                  description
                    "Display brief output (default)";
                }
                enum "extensive" {
                  value 1;
                  description
                    "Display extensive output";
                }
                enum "terse" {
                  value 2;
                  description
                    "Display terse output";
                }
              }
              default "brief";
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml hm-log-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-routing-engine-pcount-history
    
        rpc get-routing-engine-temperature-history {
          description "Show temperature history";
          input {
            leaf level {
              type enumeration {
                enum "brief" {
                  value 0;
                  description
                    "Display brief output (default)";
                }
                enum "extensive" {
                  value 1;
                  description
                    "Display extensive output";
                }
                enum "terse" {
                  value 2;
                  description
                    "Display terse output";
                }
              }
              default "brief";
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml hm-log-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-routing-engine-temperature-history
    
        rpc get-routing-engine-storage-history {
          description
            "Show storage usage history";
          input {
            leaf level {
              type enumeration {
                enum "brief" {
                  value 0;
                  description
                    "Display brief output (default)";
                }
                enum "extensive" {
                  value 1;
                  description
                    "Display extensive output";
                }
                enum "terse" {
                  value 2;
                  description
                    "Display terse output";
                }
              }
              default "brief";
            }
          }
    
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml hm-log-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-routing-engine-storage-history
    
        rpc get-snmp-v3-information {
          description
            "Show SNMP version 3 information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-v3-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-information
    
        rpc get-snmp-v3-general-information {
          description
            "Show general SNMPv3 information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-v3-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-general-information
    
        rpc get-snmp-v3-group-information {
          description
            "Show SNMPv3 security-to-group information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-v3-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-group-information
    
        rpc get-snmp-v3-usm-user-information {
          description
            "Show SNMPv3 user information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-v3-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-usm-user-information
    
        rpc get-snmp-v3-access-information {
          description
            "Show SNMPv3 access information";
          input {
            leaf 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 snmp-v3-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-access-information
    
        rpc get-snmp-v3-community-information {
          description
            "Show SNMPv3 community information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-v3-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-community-information
    
        rpc get-snmp-v3-target-information {
          description
            "Show SNMPv3 target information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-v3-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-target-information
    
        rpc get-snmp-v3-target-address-information {
          description
            "Show SNMPv3 target address information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-v3-target-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-target-address-information
    
        rpc get-snmp-v3-target-parameters-information {
          description
            "Show SNMPv3 target parameters information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-v3-target-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-target-parameters-information
    
        rpc get-snmp-v3-notify-information {
          description
            "Show SNMPv3 notify information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-v3-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-notify-information
    
        rpc get-snmp-v3-notify-filter-information {
          description
            "Show SNMPv3 notify filter information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-v3-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-v3-notify-filter-information
    
        rpc get-snmp-inform-statistics {
          description
            "Show SNMP Inform request statistics";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-inform-statistics;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-inform-statistics
    
        rpc get-snmp-proxy-information {
          description
            "Show SNMP Proxy information";
          output {
            choice output_c {
              leaf output {
                type string;
              }
              anyxml snmp-proxy-information;
              anyxml multi-routing-engine-results;
            }  // choice output_c
          }
        }  // rpc get-snmp-proxy-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-snmp
    

© 2023 YumaWorks, Inc. All rights reserved.