Cisco-IOS-XR-Subscriber-infra-subdb-oper

This module contains a collection of YANG definitions for Cisco IOS-XR Subscriber-infra-subdb package operational data. This mo...

  • Version: 2021-02-22

    Cisco-IOS-XR-Subscriber-infra-subdb-oper@2021-02-22


    
      module Cisco-IOS-XR-Subscriber-infra-subdb-oper {
    
        yang-version 1;
    
        namespace
          "http://cisco.com/ns/yang/Cisco-IOS-XR-Subscriber-infra-subdb-oper";
    
        prefix subscriber-infra-subdb-oper;
    
        import Cisco-IOS-XR-types {
          prefix xr;
        }
        import cisco-semver {
          prefix semver;
        }
    
        include Cisco-IOS-XR-Subscriber-infra-subdb-oper-sub2 {
          revision-date "2021-02-22";
        }
        include Cisco-IOS-XR-Subscriber-infra-subdb-oper-sub1 {
          revision-date "2021-02-22";
        }
    
        organization "Cisco Systems, Inc.";
    
        contact
          "Cisco Systems, Inc.
    Customer Service
    
    Postal: 170 West Tasman Drive
    San Jose, CA 95134
    
    Tel: +1 800 553-NETS
    
    E-mail: cs-yang@cisco.com";
    
        description
          "This module contains a collection of YANG definitions
    for Cisco IOS-XR Subscriber-infra-subdb package operational data.
    
    This module contains definitions
    for the following management objects:
      subscriber-database: Subscriber database operational data
    
    Copyright (c) 2013-2021 by Cisco Systems, Inc.
    All rights reserved.";
    
        revision "2021-02-22" {
          description
            "Adding yang support to retrive server connection time-stats.
    2020-11-19
      Added new bag for Subscriber database connection client statistics.";
        }
    
        revision "2020-04-02" {
          description
            "Added new bag for Subscriber database transition states and cfg object types.";
        }
    
        revision "2019-04-05" {
          description
            "Establish semantic version baseline.";
        }
    
        revision "2018-09-28" {
          description
            "Fixed Subscriber database Association.";
        }
    
        revision "2015-11-09" {
          description "IOS XR 6.0 revision.";
        }
    
        semver:module-version "2.1.0";
        semver:module-version "2.0.0";
        semver:module-version "1.0.1";
    
        typedef Sub-db-time-stat {
          type enumeration {
            enum "activate-time-stats" {
              value 0;
              description
                "SUBDB time stats activate-time-stats";
            }
            enum "config-gen-time-stats" {
              value 1;
              description
                "SUBDB time stats config-gen-time-stats";
            }
            enum "config-done-time-stats" {
              value 2;
              description
                "SUBDB time stats config-done-time-stats";
            }
            enum "apply-time-stats" {
              value 3;
              description
                "SUBDB time stats apply-time-stats";
            }
          }
          description "Sub db time stat";
        }
    
        container subscriber-database {
          config false;
          description
            "Subscriber database operational data";
          container nodes {
            description
              "List of nodes for which subscriber data is
    collected";
            list node {
              key "node-name";
              description
                "Subscriber data for a particular node";
              container subdb-assoc {
                description
                  "Subscriber data for associated templates";
                container labels {
                  description
                    "List of associated subscriber labels";
                  list label {
                    key "subscriber-label";
                    description
                      "Association for a given subscriber label";
                    leaf subscriber-label {
                      type uint32;
                      description
                        "Subscriber label";
                    }
    
                    container template {
                      description
                        "Subdb template";
                      list associated-template {
                        description
                          "Associated templates";
                        leaf template-type {
                          type Subdb-object-type-data;
                          description
                            "Template type";
                        }
    
                        leaf template-name {
                          type string {
                            length "0..65";
                          }
                          description
                            "Template name";
                        }
    
                        leaf varlist {
                          type string {
                            length "0..1000";
                          }
                          description "Varlist";
                        }
                      }  // list associated-template
                    }  // container template
    
                    leaf session-id {
                      type uint32;
                      description "Session ID";
                    }
    
                    leaf interface-name {
                      type xr:Interface-name;
                      description
                        "Interface name";
                    }
    
                    leaf associations {
                      type uint32;
                      description
                        "Association count which reflects number of
    entries in AssociatedTemplates";
                    }
    
                    leaf varlist-id {
                      type uint32;
                      description "Varlist Id";
                    }
                  }  // list label
                }  // container labels
              }  // container subdb-assoc
    
              container association {
                description
                  "Subscriber data for associated templates";
                container labels {
                  description
                    "List of associated subscriber labels";
                  list label {
                    key "subscriber-label";
                    description
                      "Association for a given subscriber label";
                    leaf subscriber-label {
                      type xr:Hex-integer;
                      description
                        "Subscriber label";
                    }
    
                    container template {
                      description
                        "Subdb template";
                      list associated-template {
                        description
                          "Associated templates";
                        leaf template-type {
                          type Subdb-object-type-data;
                          description
                            "Template type";
                        }
    
                        leaf template-name {
                          type string {
                            length "0..65";
                          }
                          description
                            "Template name";
                        }
    
                        leaf varlist {
                          type string {
                            length "0..1000";
                          }
                          description "Varlist";
                        }
                      }  // list associated-template
                    }  // container template
    
                    leaf session-id {
                      type uint32;
                      description "Session ID";
                    }
    
                    leaf interface-name {
                      type xr:Interface-name;
                      description
                        "Interface name";
                    }
    
                    leaf associations {
                      type uint32;
                      description
                        "Association count which reflects number of
    entries in AssociatedTemplates";
                    }
    
                    leaf varlist-id {
                      type uint32;
                      description "Varlist Id";
                    }
                  }  // list label
                }  // container labels
              }  // container association
    
              container summary {
                description
                  "Subscriber data for associated templates";
                container subdb-obj-counts-by-type {
                  description
                    "The count of the various configuration objects
    by type";
                  leaf object-type-min {
                    type uint32;
                    description
                      "Object type min";
                  }
    
                  leaf object-type-user-profile {
                    type uint32;
                    description
                      "Object type user profile";
                  }
    
                  leaf object-type-service-profile {
                    type uint32;
                    description
                      "Object type service profile";
                  }
    
                  leaf object-type-subsc-svc-template {
                    type uint32;
                    description
                      "Object type subsc svc template";
                  }
    
                  leaf object-type-ppp-template {
                    type uint32;
                    description
                      "Object type ppp template";
                  }
    
                  leaf object-type-ip-sub-template {
                    type uint32;
                    description
                      "Object type ipsub template";
                  }
    
                  leaf object-type-sub-template {
                    type uint32;
                    description
                      "Object type sub template";
                  }
                }  // container subdb-obj-counts-by-type
    
                container subscribers-in-state {
                  description
                    "Number of subscribers in the various states";
                  leaf init-state {
                    type uint32;
                    description
                      "Sessions in initialized state";
                  }
    
                  leaf destroying-state {
                    type uint32;
                    description
                      "Sessions in Destroying state";
                  }
    
                  leaf config-gen-state {
                    type uint32;
                    description
                      "Sessions in Config gen state";
                  }
    
                  leaf fat-gen-state {
                    type uint32;
                    description
                      "Sessions in Fat gen state";
                  }
    
                  leaf config-apply-state {
                    type uint32;
                    description
                      "Sessions in Config apply state";
                  }
    
                  leaf config-done-state {
                    type uint32;
                    description
                      "Sessions in Config done state";
                  }
    
                  leaf config-unapply-state {
                    type uint32;
                    description
                      "Sessions in Config unapply state";
                  }
    
                  leaf config-error-state {
                    type uint32;
                    description
                      "Sessions in Config error state";
                  }
    
                  leaf error-state {
                    type uint32;
                    description
                      "Sessions in error state";
                  }
    
                  leaf pre-sync-state {
                    type uint32;
                    description
                      "Sessions in pre sync state";
                  }
    
                  leaf sync-state {
                    type uint32;
                    description
                      "Sessions in sync state";
                  }
                }  // container subscribers-in-state
    
                container num-transitions-through-state {
                  description
                    "Cumulative number of transitions through the
    various states";
                  leaf init-state {
                    type uint32;
                    description
                      "Sessions in initialized state";
                  }
    
                  leaf destroying-state {
                    type uint32;
                    description
                      "Sessions in Destroying state";
                  }
    
                  leaf config-gen-state {
                    type uint32;
                    description
                      "Sessions in Config gen state";
                  }
    
                  leaf fat-gen-state {
                    type uint32;
                    description
                      "Sessions in Fat gen state";
                  }
    
                  leaf config-apply-state {
                    type uint32;
                    description
                      "Sessions in Config apply state";
                  }
    
                  leaf config-done-state {
                    type uint32;
                    description
                      "Sessions in Config done state";
                  }
    
                  leaf config-unapply-state {
                    type uint32;
                    description
                      "Sessions in Config unapply state";
                  }
    
                  leaf config-error-state {
                    type uint32;
                    description
                      "Sessions in Config error state";
                  }
    
                  leaf error-state {
                    type uint32;
                    description
                      "Sessions in error state";
                  }
    
                  leaf pre-sync-state {
                    type uint32;
                    description
                      "Sessions in pre sync state";
                  }
    
                  leaf sync-state {
                    type uint32;
                    description
                      "Sessions in sync state";
                  }
                }  // container num-transitions-through-state
    
                leaf assoc-db-entries {
                  type uint32;
                  description
                    "Number of Entries in Association DB";
                }
    
                leaf assoc-db-associations {
                  type uint32;
                  description
                    "Number of Associations in Association DB";
                }
    
                leaf derived-db-entries {
                  type uint32;
                  description
                    "Number of Entries in Derived DB";
                }
    
                leaf config-db-entries {
                  type uint32;
                  description
                    "Number of Entries in Configuration DB";
                }
    
                leaf interface-db-entries {
                  type uint32;
                  description
                    "Number of Entries in Interface DB";
                }
    
                leaf num-ipsub-dhcp {
                  type uint32;
                  description
                    "Number of IPSUB DHCP subscribers";
                }
    
                leaf num-ipsub-inband {
                  type uint32;
                  description
                    "Number of IPSUB Inband subscribers";
                }
    
                leaf num-pppoe {
                  type uint32;
                  description
                    "Number of PPPOE subscribers";
                }
              }  // container summary
    
              container connection {
                description
                  "Subscriber data for a client connected";
                container server-time-stats {
                  description
                    "Subscriber data for a client connected";
                  list server-time-stat {
                    description
                      "Subscriber timestats for client connected.";
                    leaf client-name {
                      type xr:Cisco-ios-xr-string;
                      description "Client Name";
                    }
    
                    leaf type-id {
                      type Sub-db-time-stat;
                      description
                        "Stats Type ID";
                    }
    
                    container time-statistics {
                      description
                        "Time Statistics";
                      leaf request-count {
                        type uint32;
                        description
                          "RequestCount";
                      }
    
                      leaf accumulative-time-seconds {
                        type uint32;
                        units "second";
                        description
                          "Acumulative time seconds";
                      }
    
                      leaf accumulative-time-nano-seconds {
                        type uint32;
                        units "nanosecond";
                        description
                          "Acumulative time nano-seconds";
                      }
    
                      leaf average-time-seconds {
                        type uint32;
                        units "second";
                        description
                          "Average time seconds";
                      }
    
                      leaf average-time-nano-seconds {
                        type uint32;
                        units "nanosecond";
                        description
                          "Average time nano-seconds";
                      }
    
                      leaf minimum-time-seconds {
                        type uint32;
                        units "second";
                        description
                          "Minimum time seconds";
                      }
    
                      leaf minimum-time-nano-seconds {
                        type uint32;
                        units "nanosecond";
                        description
                          "Minimum time nano-seconds";
                      }
    
                      leaf maximum-time-seconds {
                        type uint32;
                        units "second";
                        description
                          "Maximum time seconds";
                      }
    
                      leaf maximum-time-nano-seconds {
                        type uint32;
                        units "nanosecond";
                        description
                          "Maximum time nano-seconds";
                      }
    
                      leaf create-timestamp-for-maximum-seconds {
                        type uint32;
                        units "second";
                        description
                          "Create timestamp (seconds) for max time session";
                      }
    
                      leaf create-timestamp-for-maximum-nano-seconds {
                        type uint32;
                        units "nanosecond";
                        description
                          "Create timestamp (nano-seconds) for max time
    session";
                      }
    
                      leaf sub-label-for-maximum {
                        type uint32;
                        description
                          "Sub-label for max time session";
                      }
                    }  // container time-statistics
    
                    leaf client-name-xr {
                      type string;
                      description
                        "Subdb Client name";
                    }
    
                    leaf timestat-index {
                      type Subdb-req-time-stats-id;
                      description
                        "Type of statistics";
                    }
                  }  // list server-time-stat
                }  // container server-time-stats
              }  // container connection
    
              container session {
                description
                  "Subscriber management session information";
                container labels {
                  description
                    "Subscriber management list of subscriber
    labels";
                  list label {
                    key "subscriber-label";
                    description
                      "Session information for a subscriber label";
                    leaf subscriber-label {
                      type xr:Hex-integer;
                      description
                        "Subscriber label";
                    }
    
                    leaf session-state {
                      type Session-state;
                      description
                        "Subscriber session state";
                    }
    
                    leaf activate-request-id {
                      type uint32;
                      description
                        "Activate request identifier";
                    }
    
                    leaf transaction-id {
                      type int32;
                      description
                        "Transaction identifier associated with a
    particular 'produce_done' or 'produce_all_done'
    request  default value is 0xffffffff which
    represents 'None'";
                    }
    
                    leaf produce-done-request-id {
                      type uint32;
                      description
                        "Produce done request ID";
                    }
    
                    leaf destroy-req-received {
                      type boolean;
                      description
                        "Flags indicating if a destroy request is
    received";
                    }
    
                    leaf destroy-request-id {
                      type uint32;
                      description
                        "Destroy request ID";
                    }
    
                    leaf is-config-changed {
                      type boolean;
                      description
                        "Is true if configuration change due to template
    change only and not due to a produce done
    request";
                    }
    
                    leaf is-creator-gone {
                      type boolean;
                      description
                        "Is true if the creator of the connection is
    destroyed";
                    }
    
                    leaf is-delete-notify-done {
                      type boolean;
                      description
                        "Is true if the deleted features have all been
    notified and all 'apply done' ack messages have
    been received";
                    }
    
                    leaf add-modify-done {
                      type boolean;
                      description
                        "Is true if added/modified features have all been
    notified and all 'apply done' ack messages have
    been received";
                    }
    
                    leaf is-rollback-needed {
                      type boolean;
                      description
                        "Is true if the subscriber should be rolled back
    to the configuration prior to this transaction
    when all the outstanding  backend programming
    interface requests are replied";
                    }
    
                    leaf is-rollback-in-progress {
                      type boolean;
                      description
                        "Is true if subscriber's configuration is being
    rolled back";
                    }
    
                    leaf is-server-restart-apply {
                      type boolean;
                      description
                        "Is true if the subscriber's configuration is
    being applied due to subscriber database server
    restart";
                    }
    
                    leaf is-rollback-performed {
                      type boolean;
                      description
                        "Is true if rollback has previously been
    performed for this subscriber";
                    }
    
                    leaf repl-pending {
                      type boolean;
                      description
                        "Flags indicating if there is pending replication";
                    }
    
                    leaf activate-timer-running {
                      type boolean;
                      description
                        "Flags indicating if activate timer is running";
                    }
    
                    leaf apply-timer-running {
                      type boolean;
                      description
                        "Flags indicating if apply timer is running";
                    }
    
                    leaf event-queue-size {
                      type boolean;
                      description
                        "the current size of the event queue";
                    }
    
                    leaf restarts {
                      type yang:hex-string;
                      description
                        "Restart vector to keep track of the restart
    state";
                    }
    
                    leaf template-interface-id {
                      type uint32;
                      description
                        "Template Interface Identifier";
                    }
                  }  // list label
                }  // container labels
              }  // container session
    
              leaf node-name {
                type xr:Node-id;
                description "Node name";
              }
            }  // list node
          }  // container nodes
        }  // container subscriber-database
      }  // module Cisco-IOS-XR-Subscriber-infra-subdb-oper
    

© 2023 YumaWorks, Inc. All rights reserved.