module Cisco-IOS-XR-infra-smartlicense-oper {

    yang-version 1;

    namespace
      "http://cisco.com/ns/yang/Cisco-IOS-XR-infra-smartlicense-oper";

    prefix infra-smartlicense-oper;

    import cisco-semver {
      prefix semver;
    }

    include Cisco-IOS-XR-infra-smartlicense-oper-sub1 {
      revision-date "2019-04-05";
    }

    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 infra-smartlicense package operational data.
     
     This module contains definitions
     for the following management objects:
       smart-agent: Information of Smart License list and operations
     
     Copyright (c) 2013-2019 by Cisco Systems, Inc.
     All rights reserved.";

    revision "2019-04-05" {
      description
        "Establish semantic version baseline.";
    }

    revision "2015-11-09" {
      description "IOS XR 6.0 revision.";
    }

    semver:module-version "1.0.0";

    container smart-agent {
      config false;
      description
        "Information of Smart License list and operations";
      container licensing {
        description
          "Smart Licensing Module Information";
        container state {
          description
            "Smart licensing state.";
          container state-info {
            description
              "This state-info is only available if
smart-enabled = true";
            container registration {
              description
                "The state of the registration for this product
instance.";
              container registration-in-progress {
                description
                  "Registration is in progress.";
                leaf start-time {
                  type string;
                  description
                    "Time the registration started.";
                }
              }  // container registration-in-progress

              container registration-failed {
                description
                  "Registration failed.";
                leaf fail-time {
                  type string;
                  description
                    "Time the registration failed.";
                }

                leaf fail-message {
                  type string;
                  description
                    "Failure message that can be displayed for the
user.This is not a parsable message.";
                }
              }  // container registration-failed

              container registration-retry {
                description
                  "Registration failed and doing a retry.";
                container registration-info {
                  description
                    "Registration failed info.";
                  leaf fail-time {
                    type string;
                    description
                      "Time the registration failed.";
                  }

                  leaf fail-message {
                    type string;
                    description
                      "Failure message that can be displayed for the
user.This is not a parsable message.";
                  }
                }  // container registration-info

                leaf retry-next-time {
                  type string;
                  description
                    "Time the registration will be retried.";
                }
              }  // container registration-retry

              container registration-complete {
                description
                  "Registration success.";
                leaf complete-time {
                  type string;
                  description
                    "Time the registration was successful.";
                }

                leaf last-renew-time {
                  type string;
                  description
                    "Time the last registration renewal occurred. If
empty then no renewal has occurred.";
                }

                leaf next-renew-time {
                  type string;
                  description
                    "Time the registration will be automatically
renewed.";
                }

                leaf expire-time {
                  type string;
                  description
                    "Time the registration will expire if it is not
renewed.";
                }

                leaf last-renew-success {
                  type Bool-state;
                  description
                    "Was the last renewal attempt successful.";
                }

                leaf fail-message {
                  type string;
                  description
                    "If the last renewal failed then this is a
failure message that can be displayed for the
user. This is not a parsable string. Only
present if the last renewal failed";
                }

                leaf smart-account {
                  type string;
                  description
                    "The smart account name for this registration.";
                }

                leaf virtual-account {
                  type string;
                  description
                    "The virtual account name for this registration.";
                }
              }  // container registration-complete

              leaf registration-state {
                type Registration-state-enum;
                description
                  "The current registration state.";
              }

              leaf export-control-allowed {
                type Bool-state;
                description
                  "Is the device allowed to enable export
controlled features.";
              }

              leaf export-control-status {
                type Export-status-type-enum;
                description
                  "Export control status information";
              }
            }  // container registration

            container authorization {
              description
                "State of license authorization.";
              container authorization-none {
                description
                  "No licenses in use.This empty container is not
needed but is a place holder to show there is no
data for this state.";
                leaf empty {
                  type string;
                  description
                    "Empty string and container";
                }
              }  // container authorization-none

              container authorization-eval {
                description
                  "Evaluation period is in use and counting down
.The evaluation period only counts down when
licenses are in use.";
                container evaluation-time-left {
                  description
                    "Number of seconds of license usage until the
evaluation period expires.";
                  leaf seconds-left {
                    type uint64;
                    units "second";
                    description
                      "Number of seconds of license usage until the
evaluation period expires. Note that this not a
hard date and time because if no licenses are in
use the evaluation period stops counting down.";
                  }
                }  // container evaluation-time-left
              }  // container authorization-eval

              container authorization-eval-expired {
                description
                  "Evaluation period is in use but has expired.";
                leaf expire-time {
                  type string;
                  description
                    "Time the evaluation period expired.";
                }
              }  // container authorization-eval-expired

              container authorization-authorized {
                description
                  "All license usage is authorized and within terms
of the contract. uses authorization-info";
                container authorization-info {
                  description
                    "Additional authorization state information used
by some of the authorization states.";
                  leaf last-comm-status-success {
                    type Bool-state;
                    description
                      "Last communication was successful or failed.";
                  }

                  leaf fail-message {
                    type string;
                    description
                      "Failure message if the last communications
attempt failed.This can be displayed for the
user. It is not a parsable string.";
                  }

                  leaf last-comm-time {
                    type string;
                    description
                      "Time the last communication attempt happened.";
                  }

                  leaf next-comm-time {
                    type string;
                    description
                      "The next time communications will be attempted
to the back end.This will be zero if the initial
communication has not completed.";
                  }

                  leaf comm-deadline-time {
                    type string;
                    description
                      "If there are no communications between now and
this time smart licensing will enter the
authorization expired state.This may be zero
indicating there is no deadline.";
                  }
                }  // container authorization-info
              }  // container authorization-authorized

              container authorization-authorized-reservation {
                description
                  "All license usage is authorized because a
reservation authorization code is installed.";
                leaf reservation-time {
                  type string;
                  description
                    "Time the reservation occurred.";
                }
              }  // container authorization-authorized-reservation

              container authorization-out-of-compliance {
                description
                  "License usage is out of compliance with the
terms of the contract because more licenses are
in use than were purchased.";
                container authorization-info {
                  description
                    "Additional authorization state information used
by some of the authorization states.";
                  leaf last-comm-status-success {
                    type Bool-state;
                    description
                      "Last communication was successful or failed.";
                  }

                  leaf fail-message {
                    type string;
                    description
                      "Failure message if the last communications
attempt failed.This can be displayed for the
user. It is not a parsable string.";
                  }

                  leaf last-comm-time {
                    type string;
                    description
                      "Time the last communication attempt happened.";
                  }

                  leaf next-comm-time {
                    type string;
                    description
                      "The next time communications will be attempted
to the back end.This will be zero if the initial
communication has not completed.";
                  }

                  leaf comm-deadline-time {
                    type string;
                    description
                      "If there are no communications between now and
this time smart licensing will enter the
authorization expired state.This may be zero
indicating there is no deadline.";
                  }
                }  // container authorization-info

                leaf ooc-time {
                  type string;
                  description
                    "Time the product instance entered the out of
compliance state.";
                }
              }  // container authorization-out-of-compliance

              container authorization-authorization-expired {
                description
                  "The authorization period has expired because the
product instance ahs not communicated with the
SSM or satellite in over 90 days.";
                container authorization-info {
                  description
                    "Additional authorization state information used
by some of the authorization states.";
                  leaf last-comm-status-success {
                    type Bool-state;
                    description
                      "Last communication was successful or failed.";
                  }

                  leaf fail-message {
                    type string;
                    description
                      "Failure message if the last communications
attempt failed.This can be displayed for the
user. It is not a parsable string.";
                  }

                  leaf last-comm-time {
                    type string;
                    description
                      "Time the last communication attempt happened.";
                  }

                  leaf next-comm-time {
                    type string;
                    description
                      "The next time communications will be attempted
to the back end.This will be zero if the initial
communication has not completed.";
                  }

                  leaf comm-deadline-time {
                    type string;
                    description
                      "If there are no communications between now and
this time smart licensing will enter the
authorization expired state.This may be zero
indicating there is no deadline.";
                  }
                }  // container authorization-info
              }  // container authorization-authorization-expired

              leaf authorization-state {
                type Authorization-state-enum;
                description
                  "The current authorization state.";
              }
            }  // container authorization

            container utility {
              description
                "Utility settings.";
              container customer-info {
                description
                  "Customer address information that will be
included in the utility usage reports.";
                leaf id {
                  type string;
                  description
                    "The cisco issued customer id which will be
included in the utility usage (RUM) report.";
                }

                leaf name {
                  type string;
                  description
                    "The customer company name which will be included
in the utility usage (RUM) report.";
                }

                leaf street {
                  type string;
                  description
                    "The customer company street address which will
be included in the utility usage (RUM) report.";
                }

                leaf city {
                  type string;
                  description
                    "The customer company city which will be included
in the utility usage (RUM) report.";
                }

                leaf state {
                  type string;
                  description
                    "The customer company state which will be
included in the utility usage (RUM) report.";
                }

                leaf country {
                  type string;
                  description
                    "The customer company country which will be
included in the utility usage (RUM) report.";
                }

                leaf postal-code {
                  type string;
                  description
                    "The customer location specific postal code which
will be included in the utility usage (RUM)
report.";
                }
              }  // container customer-info

              leaf utility-enable {
                type Bool-state;
                description
                  "Flag to indicate if Utility is currently enabled";
              }

              leaf reporting {
                type Utility-reporting-type-enum;
                description
                  "Is the system reporting utility data.";
              }
            }  // container utility

            container transport {
              description
                "Transport layer settings.";
              container url-settings {
                description
                  "URLs in use if the transport type is smart.";
                leaf url-registration {
                  type string;
                  description
                    "The URL used for registration, authorization and
any other messages not related to utility.";
                }

                leaf url-utility {
                  type string;
                  description
                    "The URL used for utility reporting. url-utility
and url-registration may be the same or
different. If a satellite is in use then they
will probably be the same.";
                }
              }  // container url-settings

              container proxy-info {
                description
                  "Proxy information if the transport type is smart
.";
                leaf address {
                  type string;
                  description
                    "Proxy address for sending message.";
                }

                leaf port {
                  type string;
                  description
                    "Proxy port for sending message.";
                }
              }  // container proxy-info

              leaf transport-type {
                type Transport-type-enum;
                description
                  "The communications transport type set in the
config";
              }
            }  // container transport

            container privacy {
              description
                "Controls whether or not some information is sent
in messages to the Cisco Smart Software Manger
(CSSM) or satellite.";
              leaf host-name {
                type Bool-state;
                description
                  "If true then the hostname will not be sent in
any messages.";
              }

              leaf version {
                type Bool-state;
                description
                  "If true then the smart licensing version will
not be sent in any messages.";
              }
            }  // container privacy

            container evaluation {
              description
                "State of the evaluation period. In use or not
and time left.";
              container eval-period-left {
                description
                  "If the evaluation period is not expired this is
the number of seconds left in the period.";
                leaf time-left {
                  type uint64;
                  units "second";
                  description
                    "Number of seconds of license usage until the
evaluation period expires.";
                }
              }  // container eval-period-left

              container eval-expire-time {
                description
                  "If the evaluation period has expired then this
is the time of the expiration.";
                leaf expire-time {
                  type string;
                  description
                    "Date and time the evaluation period expired.";
                }
              }  // container eval-expire-time

              leaf eval-in-use {
                type Bool-state;
                description
                  "Is the evaluation period currently in use and
counting down.";
              }

              leaf eval-expired {
                type Bool-state;
                description
                  "Has the evaluation period expired.";
              }
            }  // container evaluation

            container udi {
              description
                "UDI of the system.";
              leaf pid {
                type string;
                description
                  "The Product Identifier. Always combined with sn.";
              }

              leaf sn {
                type string;
                description
                  "The system serial number. Always combined with
pid.";
              }

              leaf vid {
                type string;
                description
                  "The version identifier. Usually combined with
pid & sn.";
              }

              leaf uuid {
                type string;
                description
                  "A 32 byte hex value generated by the system.
This will be in proper UUID format 8-4-4-4-12.
Often used by VMs or other systems that do not
have a hardware identifier.";
              }

              leaf suvi {
                type string;
                description
                  "Free form virtual identifier often used by
software only devices like software routers or
VMs.";
              }

              leaf host-identifier {
                type string;
                description
                  "Host identifier available on some systems.
Typically 8 hex digits.";
              }

              leaf mac-address {
                type string;
                description
                  "The MAC address of the system. This is usually
only used if there  is nothing else available to
be used as an identifier.";
              }
            }  // container udi

            container reservation {
              description
                "Information about all licenses that are
authorized and how they were authorized";
              list overall-status {
                description
                  "list of all reservation status information for
all UDIs";
                container udi {
                  description
                    "UDI of this device";
                  leaf pid {
                    type string;
                    description
                      "The Product Identifier. Always combined with sn.";
                  }

                  leaf sn {
                    type string;
                    description
                      "The system serial number. Always combined with
pid.";
                  }

                  leaf vid {
                    type string;
                    description
                      "The version identifier. Usually combined with
pid & sn.";
                  }

                  leaf uuid {
                    type string;
                    description
                      "A 32 byte hex value generated by the system.
This will be in proper UUID format 8-4-4-4-12.
Often used by VMs or other systems that do not
have a hardware identifier.";
                  }

                  leaf suvi {
                    type string;
                    description
                      "Free form virtual identifier often used by
software only devices like software routers or
VMs.";
                  }

                  leaf host-identifier {
                    type string;
                    description
                      "Host identifier available on some systems.
Typically 8 hex digits.";
                  }

                  leaf mac-address {
                    type string;
                    description
                      "The MAC address of the system. This is usually
only used if there  is nothing else available to
be used as an identifier.";
                  }
                }  // container udi

                leaf install-status {
                  type Install-status-enum;
                  description
                    "Install Status";
                }

                leaf status-time {
                  type string;
                  description "Status Time";
                }

                leaf export-control-status {
                  type Export-status-type-enum;
                  description
                    "Export control status information";
                }

                leaf request-code {
                  type string;
                  description "Request code";
                }

                leaf return-code {
                  type string;
                  description "ReturnCode";
                }

                leaf confirmation-code {
                  type string;
                  description
                    "ConfirmationCode";
                }

                leaf authorization-code {
                  type string;
                  description
                    "AuthorizationCode";
                }

                leaf error-message {
                  type string;
                  description "ErrorMessage";
                }
              }  // list overall-status

              list authorization {
                description
                  "Information about how a single license is
authorized.";
                leaf entitlement-tag {
                  type string;
                  description
                    "The ISO 19770-2 entitlement tag used to define
this license";
                }

                leaf short-name {
                  type string;
                  description
                    "The human readable license name from the
entitlement tag.";
                }

                leaf license-name {
                  type string;
                  description
                    "The license name that can be seen on the Cisco
Smart Software Manger (CSSM).";
                }

                leaf description {
                  type string;
                  description
                    "The long description of this license.";
                }

                leaf total-count {
                  type int32;
                  description
                    "The total aggregated count available for this
license.";
                }

                leaf license-enforcement-type {
                  type License-enforcement-type-enum;
                  description
                    "Indicates what type of license this is.";
                }

                list term-info {
                  description
                    "the list of term info for each UDI This is an
array of structures";
                  container udi {
                    description
                      "the UDI and HA role for this reservation
information";
                    leaf pid {
                      type string;
                      description
                        "The Product Identifier. Always combined with sn.";
                    }

                    leaf sn {
                      type string;
                      description
                        "The system serial number. Always combined with
pid.";
                    }

                    leaf vid {
                      type string;
                      description
                        "The version identifier. Usually combined with
pid & sn.";
                    }

                    leaf uuid {
                      type string;
                      description
                        "A 32 byte hex value generated by the system.
This will be in proper UUID format 8-4-4-4-12.
Often used by VMs or other systems that do not
have a hardware identifier.";
                    }

                    leaf suvi {
                      type string;
                      description
                        "Free form virtual identifier often used by
software only devices like software routers or
VMs.";
                    }

                    leaf host-identifier {
                      type string;
                      description
                        "Host identifier available on some systems.
Typically 8 hex digits.";
                    }

                    leaf mac-address {
                      type string;
                      description
                        "The MAC address of the system. This is usually
only used if there  is nothing else available to
be used as an identifier.";
                    }
                  }  // container udi

                  list term-count {
                    description
                      "The list of term information";
                    leaf type {
                      type License-term-type-enum;
                      description
                        "The type of the term license.";
                    }

                    leaf count {
                      type int32;
                      description
                        "The count for this term.";
                    }

                    leaf start-date {
                      type string;
                      description
                        "The date and time the term starts.";
                    }

                    leaf end-date {
                      type string;
                      description
                        "The date and time the term ends.";
                    }

                    leaf subscription-id {
                      type string;
                      description
                        "SubscriptionId";
                    }
                  }  // list term-count
                }  // list term-info
              }  // list authorization
            }  // container reservation

            container export-authorization-keys {
              description
                "Export Authorization Keys";
              container export-key-request-status {
                description
                  "ExportKeyRequestStatus";
                leaf status {
                  type Export-status-time-enum;
                  description "Status";
                }

                leaf operation-time {
                  type string;
                  description
                    "OperationTime";
                }

                leaf operation-next-time {
                  type string;
                  description
                    "operationNextTime";
                }

                leaf failure-message {
                  type string;
                  description
                    "FailureMessage";
                }
              }  // container export-key-request-status

              container export-key-return-status {
                description
                  "ExportKeyReturnStatus";
                leaf status {
                  type Export-status-time-enum;
                  description "Status";
                }

                leaf operation-time {
                  type string;
                  description
                    "OperationTime";
                }

                leaf operation-next-time {
                  type string;
                  description
                    "operationNextTime";
                }

                leaf failure-message {
                  type string;
                  description
                    "FailureMessage";
                }
              }  // container export-key-return-status

              container export-return-keys {
                description
                  " ExportReturnKeys";
                leaf num-elements {
                  type int32;
                  description "NumElements";
                }

                list list {
                  description "List";
                  container udi {
                    description "UDI";
                    leaf pid {
                      type string;
                      description
                        "The Product Identifier. Always combined with sn.";
                    }

                    leaf sn {
                      type string;
                      description
                        "The system serial number. Always combined with
pid.";
                    }

                    leaf vid {
                      type string;
                      description
                        "The version identifier. Usually combined with
pid & sn.";
                    }

                    leaf uuid {
                      type string;
                      description
                        "A 32 byte hex value generated by the system.
This will be in proper UUID format 8-4-4-4-12.
Often used by VMs or other systems that do not
have a hardware identifier.";
                    }

                    leaf suvi {
                      type string;
                      description
                        "Free form virtual identifier often used by
software only devices like software routers or
VMs.";
                    }

                    leaf host-identifier {
                      type string;
                      description
                        "Host identifier available on some systems.
Typically 8 hex digits.";
                    }

                    leaf mac-address {
                      type string;
                      description
                        "The MAC address of the system. This is usually
only used if there  is nothing else available to
be used as an identifier.";
                    }
                  }  // container udi

                  leaf num-strings {
                    type int32;
                    description "numStrings";
                  }

                  list return-key {
                    description
                      "returnKeyList";
                    leaf key {
                      type string;
                      description "Key";
                    }
                  }  // list return-key
                }  // list list
              }  // container export-return-keys

              container export-features-authorized {
                description
                  "ExportFeaturesAuthorized";
                leaf num-elements {
                  type int32;
                  description "NumElements";
                }

                list list {
                  description "List";
                  container udi {
                    description "UDI";
                    leaf pid {
                      type string;
                      description
                        "The Product Identifier. Always combined with sn.";
                    }

                    leaf sn {
                      type string;
                      description
                        "The system serial number. Always combined with
pid.";
                    }

                    leaf vid {
                      type string;
                      description
                        "The version identifier. Usually combined with
pid & sn.";
                    }

                    leaf uuid {
                      type string;
                      description
                        "A 32 byte hex value generated by the system.
This will be in proper UUID format 8-4-4-4-12.
Often used by VMs or other systems that do not
have a hardware identifier.";
                    }

                    leaf suvi {
                      type string;
                      description
                        "Free form virtual identifier often used by
software only devices like software routers or
VMs.";
                    }

                    leaf host-identifier {
                      type string;
                      description
                        "Host identifier available on some systems.
Typically 8 hex digits.";
                    }

                    leaf mac-address {
                      type string;
                      description
                        "The MAC address of the system. This is usually
only used if there  is nothing else available to
be used as an identifier.";
                    }
                  }  // container udi

                  leaf num-strings {
                    type int32;
                    description "numStrings";
                  }

                  list return-key {
                    description
                      "returnKeyList";
                    leaf key {
                      type string;
                      description "Key";
                    }
                  }  // list return-key
                }  // list list
              }  // container export-features-authorized
            }  // container export-authorization-keys

            leaf custom-id {
              type string;
              description
                "The custom ID set by the customer that will be
included in the utility usage (RUM) report and
in th emessage header";
            }

            leaf conversion-enabled {
              type Bool-state;
              description
                "Conversion Enabled or not";
            }

            list usage {
              description
                "List of license (entitlement tag) usage
information. This only contains the information
for licenses that are in use.";
              container reservation-usage {
                description
                  "Reservation Usage";
                leaf reservation-usage-status {
                  type Reservation-usage-status-enum;
                  description
                    "ReservationUsageStatus";
                }

                leaf total-reserved-count {
                  type int32;
                  description
                    "totalReservedCount";
                }
              }  // container reservation-usage

              leaf entitlement-tag {
                type string;
                description
                  "The ISO 19770 entitlement tag used to define
this license.";
              }

              leaf short-name {
                type string;
                description
                  "The human readable license name from the
entitlement tag.";
              }

              leaf license-name {
                type string;
                description
                  "The license name that can be seen in the CSSM
portal or on the satellite.This is only
available after the product has registered.";
              }

              leaf description {
                type string;
                description
                  "The long description of this license.This is
only available after the product has registered.";
              }

              leaf count {
                type uint32;
                description
                  "The in-use count of this license. Note that
licensing only reports usage for licenses that
are in use (count of 1 or greater).";
              }

              leaf enforce-mode {
                type Enforcement-mode-enum;
                description
                  "The current enforcement mode of this license.";
              }

              leaf post-paid {
                type Bool-state;
                description
                  "If true then this entitlement is being reported
in a post paid mode with utility usage reports.
Otherwise it will be reported in the regular
prepaid mode.";
              }

              leaf subscription-id {
                type string;
                description
                  "Subscription ID for this feature.";
              }

              leaf export-entitlement-status {
                type Export-entitlement-status-enum;
                description
                  "exportEntitlementStatus";
              }

              leaf feature-description {
                type string;
                description
                  "FeatureDescription";
              }

              leaf feature-name {
                type string;
                description "FeatureName";
              }
            }  // list usage
          }  // container state-info

          leaf always-enabled {
            type Bool-state;
            description
              "Is Smart Licensing is always enabled.";
          }

          leaf smart-enabled {
            type Bool-state;
            description
              "Is smart licensing enabled";
          }

          leaf version {
            type string;
            description
              "The smart licensing version in use.";
          }
        }  // container state
      }  // container licensing
    }  // container smart-agent
  }  // module Cisco-IOS-XR-infra-smartlicense-oper