Commit 07b1f92d authored by Zu Qiang's avatar Zu Qiang 🛀
Browse files

Update file _3gpp-5gc-nrm-stmfunction.yang

parent ef04eb28
Loading
Loading
Loading
Loading
Loading
+142 −0
Original line number Diff line number Diff line
module _3gpp-5gc-nrm-stmfunction {
  yang-version 1.1;
  
  namespace urn:3gpp:sa5:_3gpp-5gc-nrm-stmfunction;
  prefix stm3gpp;
  
  import _3gpp-common-managed-function { prefix mf3gpp; }
  import _3gpp-common-managed-element { prefix me3gpp; }
  import _3gpp-common-yang-types { prefix types3gpp; }
  import _3gpp-5g-common-yang-types { prefix types5g3gpp; }
  import _3gpp-common-top { prefix top3gpp; }
  
  organization "3gpp SA5";
  description "This IOC represents the STM function defined in 3GPP TS 28.abc.
    Copyright 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, 
    TTA, TTC). All rights reserved.";
  reference "3GPP TS 28.abc
    Signalling traffic monitoring management";
  
  revision 2024-11-07 { reference "S5-24xxxx"; } 
  
  grouping StmReferenceGrp{
    description "This <<dataType>> defines a globally unique identifier, which 
      uniquely identifies the StmReportingCtrl that is created by STM consumer. 
      It composes with a consumer identifier followed by a STM identifier. 
      The consumer identifier is one-byte octet string, and it is assigned by 
      the operator. The STM identifier is two-byte octet string, and it is 
      generated by the consumer.";
    
      leaf consumerId {
        type string;
        mandatory true;
        description "A one-byte octet string identifier";
      }
      
      leaf stmId {
        type string;
        mandatory true;
        description "A two-byte octet string identifier";
      }
  }

  grouping STMFunctionGrp {
    leaf stmTargetUri {
      type inet:uri;
      description "It specifies the Uniform Resource Identifier (URI) of the 
      streaming target where the signalling traffic shall be sent. ";
      reference "Clause 4.4 of 3GPP TS 32.158";
    }
    
    list stmRef {
      key "idx";
      min-elements 1;
      max-elements 1;
      description "A globally unique identifier, which uniquely identifies the
        StmReportingCtrl.";

      leaf idx { type uint32 ; }
      uses trace3gpp:StmReferenceGrp ;    
    }

    leaf-list networkInterfaceType {
      type enumeration {
        enum ALL;
        enum N4;
        enum N5;
        enum N7;
        enum N8;
        enum N10;
        enum N11;
        enum N12;
        enum N13;
        enum N14;
        enum N15;
        enum N22;
        enum N58;
        enum N59;
        enum N80;
        enum N81;
      }
      description "List of network interface type. The value ALL is specified
        for the case if all the applicable interface type of the network 
        function shall be monitored. ";
      reference "Clause 4.2.3 of 3GPP TS 23.501 for details on the
        allowed values.";
    }

    leaf-list reportingNF {
      type string;
      description "List of Network Function Distinguished Name";   
    }

    leaf administrativeState {
      default UNLOCKED;
      type types3gpp:BasicAdministrativeState ;
      description "Enable or disables production of the metrics";
    }

    leaf operationalState {
      config false;
      mandatory true;
      type types3gpp:OperationalState ;
      description "Indicates whether the PerfMetricJob is working.";
    }
  }

  grouping STMFunctionSubTree {
   description "Helps with augmenting QMCJob into multple places.";
    list QMCJob {
      description "This IOC represents the STM Control and Configuration 
        parameters of a particular STM reporting controlling. It can be 
        name-contained by SubNetwork, ManagedElement, or ManagedFunction.
        stmRef is a globally unique identifier, which uniquely identifies 
        a StmReportingCtrl object instance. 
        reportingNFList is the parameter on which network function the 
        signalling traffic shall be monitored. This parameter is defined by 
        the STM consumer. This parameter may be omitted if the STM reporting 
        control object is specified under a ManagedFunction.
        networkInterfaceTypeList is the parameter on which network interface 
        type shall be monitored. This parameter is defined by the STM consumer. 
        streamTargetUri is the URI of the STM consumer to which the STM report
        shall be streamed.";
      key id;
      uses top3gpp:Top_Grp;
      container attributes {
        uses STMFunctionGrp;
      }
    }
  }
  
  augment "/subnet3gpp:SubNetwork" {
        uses STMFunctionSubTree;
  }

  augment "/subnet3gpp:ManagedFunction" {
        uses STMFunctionSubTree;
  }

  augment "/me3gpp:ManagedElement" {
        uses STMFunctionSubTree;
  }
}
 No newline at end of file