Commit 84e0ece8 authored by lengyelb's avatar lengyelb Committed by lengyelb
Browse files

S5-252275

parent fe36e7ba
Loading
Loading
Loading
Loading
+135 −0
Original line number Diff line number Diff line
module _3gpp-common-externaldata {
  yang-version 1.1;
  namespace "urn:3gpp:sa5:_3gpp-common-externaldata";
  prefix "exdata3gpp";

  import _3gpp-common-subnetwork { prefix subnet3gpp; }
  import _3gpp-common-top { prefix top3gpp; }
  import _3gpp-common-yang-types { prefix types3gpp; }
  import ietf-inet-types { prefix inet; }

  organization "3GPP SA5";
  contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464";
  description "Defines the YANG mapping of the external data.
    Copyright 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, 
    TTA, TTC). All rights reserved.";
  reference "3GPP TS 28.623 Generic Network Resource Model (NRM)";

  revision 2025-07-19 { reference CR-0551; }
  
    grouping ExternalDataScopeGrp {
      list geoAreas {
        description "It describes the concrete geographical area(s)";
        key idx;
        leaf idx { type uint32; }
        uses types3gpp:GeoAreaGrp;
      }
      
      leaf-list objectInstancesIncluded {
        type types3gpp:DistinguishedName;
        description "List of managed object instances to which the described 
          data are related. Each object instance is identified by its DN.";
      }
      
      leaf-list objectInstancesExcluded {
        type types3gpp:DistinguishedName;
        description "List of managed object instances which are not considered 
          in relation to the described data. Each object instance is identified 
          by its DN.";
      }
    }

    grouping ExternalDataTypeGrp {
    description "Represents the IOC ExternalDataType";
    
    leaf externalDataType {
      type string;
      mandatory true;
      description "Type of external management data as defined by the 
        implementation.

        Examples: 'Electronic Map', 'Camara Data', 'UE path', 'Camera Photo', 
        'Event Schedule”";
    } 
    
    leaf-list mediaLocation {
      type inet:uri;
      description "URI of the media which includes the transfer protocol. 

      Examples:
      sftp://companyA.com/datastore/fileName.xml
      https://companyA.com/ManagedElement=1/Files=1/File=1";
    } 
    
    leaf externalDataTypeSchema {
      type inet:uri;
      mandatory true;
      description "URI of the schema to parse a type of external management data.
      The detailed schema definition for the different types of external
      management data is out of scope of this specification.";
    } 
    
    list externalDataScope {
      description "It describes the concrete scope which the external management 
        data is applicable.";
      key idx;
      leaf idx { type uint32; }
      uses ExternalDataScopeGrp;
    } 
  }
  
  augment /subnet3gpp:SubNetwork {
    list ExternalDataType {
      description "This IOC specifies a type of external management data and 
      the associated meta data.

      External management data is data which enrich 3GPP specified management 
      data and management data specified based on 3GPP defined management data 
      definition templates and frameworks. External management data can be 
      produced by data sources of different nature (e.g. sensors) with different 
      formats. Details see clause 6.4.1 in TS 28.537.

      MnS producer may use this IOC to describe external management data. 

      For example, MnS producer publishes all external management data which 
      are available.

      MnS consumer may use this IOC to configure, discover or request external 
      management data. For example, MnS consumer discovers and requests certain 
      types of external management data.

      The ExternalDataType IOC can be name-contained by SubNetwork.

      Attribute externalDataType defines the type of external management data. 

      Attribute mediaLocation indicates the address from which the described 
      external management data can be retrieved. 

      The value of mediaLocation, if present, can provide one or several 
      directories or the address where the described external management data 
      can be retrieved. The different directories can be used to group the 
      external management data, e.g., one directory per geographical area or 
      per time period. For example, the value of the mediaLocation attribute 
      can be given by
    
      sftp://companyA.com/datastore/weatherforecasts/

      In this case a potential file with name 'weatherforecastMunicht0.xml' 
      needs to be retrieved using 'sftp' from 
      
      sftp://companyA.com/datastore/weatherforecasts/weatherforecastMunicht0.xml.

      Attribute externalDataTypeSchema indicates the URI where the MnS consumer 
      can get the schema to parse the external management data.

      Attribute externalDataScope is used to describe the concrete scope (e.g.,
      geographical areas) which the external management data is applicable.";
      
      key id;
      uses top3gpp:Top_Grp;
      container attributes {
        uses ExternalDataTypeGrp;
      }
    }
  }
}
 No newline at end of file
+210 −83
Original line number Diff line number Diff line
@@ -24,6 +24,7 @@ module _3gpp-common-managementdatacollection {
      Integration Reference Point (IRP);
      Information Service (IS)";

  revision 2025-07-19 { reference CR-0551; }
  revision 2025-02-07 { reference "CR-0461 CR-0505"; } 
  revision 2024-04-12 { reference CR-0346; } 
  revision 2023-11-18 { reference CR-0299 ; }
@@ -32,6 +33,82 @@ module _3gpp-common-managementdatacollection {
  revision 2023-02-14 { reference "CR-0234"; }
  revision 2022-11-04 { reference "CR-0194"; }
  
  grouping ManagementDataGrp {
    description "This <<choice>> defines the management data which is 
      requested. It is a choice between 
      - 	a list of data categories (attribute mgtDataCategory) This may include 
      'COVERAGE', 'CAPACITY', 'MOBILITY', 'ENERGY_EFFICIENCY', 'ACCESSIBILITY' 
      etc. The mapping of exact measurement with the requested category will be 
      done at the producer and is implementation specific. 
      - 	a list of management data identified with their name (attribute 
      'mgtDataName'). The management data name presents a specific single
      measurement (e.g. by selecting 'RRU.PrbTotDl', see TS 28.552 or 
      'immediateMdt.nr.m1', see TS 32.422) or a set of measurements (e.g. 
      measurement families such as RRU (radio resource utilization) or 
      MM (mobility management) in case of PM, see TS 28.552 [20], or group of 
      measurements such as 'immediateMdt.nr' in case of MDT, see TS 32.422).";
    choice managementData {
      case mgtDataCategory {
        leaf-list category  {
          type mgtDataCategoryType;
          min-elements 1;
          max-elements 5; // The ENUM contains 5 possible values
          description "This attributes defines the type of management data that
            are requested.

            Allowed values for data category are COVERAGE, CAPACITY,
            ENERGY_EFFICIENCY, MOBILITY, ACCESSIBILITY. The data categories
            will map to certain measurement families defined in TS 28.552, see
            below. In addition to the below mappings, MnS producer may map the
            provided categories to any additional proprietary management data,
            as appropriate.

            - The COVERAGE category will map to measurement families of MR
            (measurements related to Measurement Report) and L1M (measurements
            related to Layer 1 Measurement).

            - The CAPACITY category will map to measurement family RRU
            (measurements related to Radio Resource Utilization).

            - The ENERGY_EFFICIENCY category will map to measurement family PEE
            (measurements related to Power, Energy and Environment).

            - The MOBILITY category will map to measurement family MM
            (measurements related to Mobility Management).

            - The ACCESSIBILITY category will map to measurement family CE
            (measurements related to Connection Establishment).";
        }
      }
      case mgtDataName {
        leaf-list name {
          type string;
          min-elements 1;
          description "List of management data identified by name.

          The list may include metrics or set of metrics defined
            in TS 28.552, TS 28.554 and TS 32.422.

            The metrics are identified with their names/identifiers.
            For performance measurements defined in TS 28.552 the name is
            constructed as the bullet e) of the measurement definition.

            For KPIs defined in TS 28.554 the name is defined according to the
            KPI definitions template as the component designated with a).

            For trace metrics (including trace messages, MDT measurements
            (Immediate MDT, Logged MDT, Logged MBSFN MDT), RRC, RLF and RCEF
            reports) defined in TS 32.422, the name (metric identifier) is
            defined in clause 10 of TS 32.422.
            
            For non-3GPP specified managment data the name is defined 
            elsewhere.";
          }
      }
      mandatory true;
    }
  }
  
  grouping GeoAreaToCellMappingGrp {
    description "Represents the GeoAreaToCellMapping data type. 
      
@@ -155,6 +232,13 @@ module _3gpp-common-managementdatacollection {
        subnet should be targeted. Please refer to 3GPP TS 23.501: 'System
        Architecture for the 5G System'";
    }
    
    leaf-list objectInstances {
      type types3gpp:DistinguishedName;
      yext3gpp:inVariant;
      description "List of managed object instances. Each object instance is 
        identified by its DN.";
    }
  }

  typedef mgtDataCategoryType {
@@ -170,65 +254,9 @@ module _3gpp-common-managementdatacollection {

  grouping ManagementDataCollectionGrp {

    choice managementData {
      case mgtDataCategory {
        leaf-list category  {
          type mgtDataCategoryType;
          min-elements 1;
          max-elements 5; // The ENUM contains 5 possible values
          description "This attributes defines the type of management data that
            are requested.

            Allowed values for data category are COVERAGE, CAPACITY,
            ENERGY_EFFICIENCY, MOBILITY, ACCESSIBILITY. The data categories
            will map to certain measurement families defined in TS 28.552, see
            below. In addition to the below mappings, MnS producer may map the
            provided categories to any additional proprietary management data,
            as appropriate.

            - The COVERAGE category will map to measurement families of MR
            (measurements related to Measurement Report) and L1M (measurements
            related to Layer 1 Measurement).

            - The CAPACITY category will map to measurement family RRU
            (measurements related to Radio Resource Utilization).

            - The ENERGY_EFFICIENCY category will map to measurement family PEE
            (measurements related to Power, Energy and Environment).

            - The MOBILITY category will map to measurement family MM
            (measurements related to Mobility Management).

            - The ACCESSIBILITY category will map to measurement family CE
            (measurements related to Connection Establishment).";
        }
      }
      case mgtDataName {
        leaf-list name {
          type string;
          min-elements 1;
          description "List of management data identified by name.

          The list may include metrics or set of metrics defined
            in TS 28.552, TS 28.554 and TS 32.422.

            The metrics are identified with their names/identifiers.
            For performance measurements defined in TS 28.552 the name is
            constructed as the bullet e) of the measurement definition.

            For KPIs defined in TS 28.554 the name is defined according to the
            KPI definitions template as the component designated with a).

            For trace metrics (including trace messages, MDT measurements
            (Immediate MDT, Logged MDT, Logged MBSFN MDT), RRC, RLF and RCEF
            reports) defined in TS 32.422, the name (metric identifier) is
            defined in clause 10 of TS 32.422.
            
            For non-3GPP specified managment data the name is defined 
            elsewhere.";
          }
      }
      mandatory true;
    uses ManagementDataGrp {
      description "This attribute defines the list of management data that are 
        requested.";
    }

    list targetNodeFilter {
@@ -271,6 +299,48 @@ module _3gpp-common-managementdatacollection {
        description "It specifies whether the required data is reported per
          S-NSSAI or per 5QI.";
    }
    
    leaf condition {
      type string;
      mandatory true;
      yext3gpp:inVariant;
      description "Logical expression of one or several condition(s). 

      The actual syntax and capabilities of condition is SS specific. However, 
      each SS should support condition consisting of one or several assertions 
      that may be grouped using the logical operators AND, OR and NOT. Only if 
      the whole expression of condition evaluates TRUE, the attribute 
      conditionStatus will be TRUE.

      Each assertion is a pointer to a Boolean parameter or a logical 
      expression of attribute existence or attribute value comparison 
      ('equal to X, less than Y' etc.).

      An empty string is not allowed.";
    }
    
    list processMonitor {
      config false;
      min-elements 1;
      max-elements 1;
      key idx;
      leaf idx { type string; }      
      description "Indicates the process of the ManagementDataCollection MOI.";
    }
    
    leaf consolidateOutput {
      type boolean;
      mandatory true;
      yext3gpp:inVariant;
      description "Indicates whether the management data collection output will 
        be consolidated into a single file per reporting period.";
    }
    
    leaf jobId {
      type string;
      yext3gpp:inVariant;
      description "Identifier of a PerfMetricJob, a TraceJob or a QMCJob.";
    }
  }

  augment /subnet3gpp:SubNetwork {
@@ -282,16 +352,18 @@ module _3gpp-common-managementdatacollection {
          uses ManagementDataCollectionGrp;
      }
      description "This IOC represents a management data collection request
        job. The requested data could be of kind Trace, MDT (Minimization
        job. The requested data is of kind Trace, MDT (Minimization
        of Drive Test), RLF (Radio Link Failure) report, RCEF (RRC Connection
        Establishment Failure) report, RRC report, 
        PM (performance measurements), KPI
        (end-to-end key performance indicators) or a combination of these.

        The attribute 'managementData' defines the management data which shall
        The attribute managementData defines the management data which shall
        be reported. This may either include a list of data categories or a
        list of management data identified with their name. For further details
        see TS 28.622 clause 4.3.50. The 'targetNodeFilter' attribute can be
        see TS 28.622 clause 4.3.50. 
        
        The targetNodeFilter attribute can be
        used to target object instance(s) producing the required management
        data. It is assumed that the consumer may not have detailed knowledge
        of the network and hence may not identify the exact object instance
@@ -302,27 +374,82 @@ module _3gpp-common-managementdatacollection {
        function.

        To activate the production of the requested data, a MnS consumer has to
        create a 'ManagementDataCollection' object instance on the MnS producer.

        The MnS producer will derive multiple jobs ('PerfMetricJob',
        'TraceJob') from a single 'ManagementDataCollection' job for collecting
        the required management data. Once it receives the measurement from
        multiple sources, it consolidates the data into a set of management data
        for reporting.

        The attribute 'collectionTimeWindow' specifies the time window for which
        the management data should be reported.

        The attribute 'reportingCtrl' specifies the method and associated
        control parameters for reporting the produced management data to MnS
        consumers. Three methods are available: file-based reporting with
        selection of the file location by the MnS producer, file-based
        reporting with selection of the file location by the MnS consumer and
        stream-based reporting.

        The attribute 'dataScope' configures, whether the management data
        should be reported per S-NSSAI or per 5QI, if applicable.";
        create a ManagementDataCollection object instance on the MnS producer.

        The attribute jobId is used to identify a management data collection 
        request.
        
        The production and reporting of the management data can be constrained 
        by conditions such that only when the conditions are satisfied shall 
        management data collection be enabled. For example, a MnS consumer can 
        request to create two ManagementDataCollection instances. One can be 
        configured with high data producing and reporting period on a set of 
        conditions (e.g, to reduce transmission cost when network performance 
        metric is in normal range). Another can be configured with low data 
        producing and reporting period on another set of conditions (e.g. to 
        enable network optimization when network performance metric is in 
        abnormal range).

        The MnS producer may derive multiple jobs (PerfMetricJob, TraceJob) 
        from a single ManagementDataCollection job for collecting the required 
        management data. The jobId of the request is used to identify the 
        output.  The value is also used to correlate the derived jobs which 
        will have the same jobId value as the ManagementDataCollection.

        If the MnS producer receives the collected data from multiple sources, 
        it will consolidate the data into a set of management data for 
        reporting based on the value of the attribute consolidateOutput.

        For consolidation of file-based management data the attribute 
        consolidateOutput controls:
        - 	True: the MnS Producer will combine the file output from jobs used 
        to collect the required management data into a single output file as 
        follows:
          - File is in compressed format, i.e. zip.
          -	File shall contain individual output files from each configured job
          - Each file retains its original filename
          -	Each file retains it original content
        -	Consolidated filename uses naming convention defined in, 
        TS 28.532 clause 11.3.2.1.4 with the following:
          -	<Type> is a combination of the management data types included in 
          the consolidated output
          -	<UniqueIdList> is omitted 
        -	False: the MnS Producer will not combine the output from jobs used to collect the required management data.  The MnS Consumer will receive separate output from the derived jobs.

        Subject to the reporting method, the MnS Consumer may receive file 
        related notifications.  When consolidated output is selected the 
        MnS Producer will create file notifications for the consolidated files.  
        When consolidated output is not selected, the MnS Producer will create 
        the notification subscriptions on behalf of the MnS Consumer and the 
        MnS Consumer will receive notifications directly from the derived jobs.

        The attribute collectionTimeWindow specifies the time window for which 
        the management data should be reported. The attributes startTime and 
        the endTime can be in the past, present or in the future.

        The attribute reportingCtrl specifies the method and associated control 
        parameters for reporting the produced management data to MnS consumers. 
        Three methods are available: file-based reporting with selection of the 
        file location by the MnS producer, file-based reporting with selection 
        of the file location by the MnS consumer and stream-based reporting.

        The attribute dataScope configures, whether the management data should 
        be reported per S-NSSAI or per 5QI or per PLMN, if applicable.

        The attribute processMonitor allows the MnS consumer to monitor the 
        status of the management data collection represented by the object 
        ManagementDataCollection.

        The MnS producer indicates in the attribute progressStateInfo the 
        state of the management data collection:
        -	NOT_STARTED
        - RUNNING
        - CANCELING
        and indicates in the attribute resultStateInfo:
        -	FINISHED
        -	FAILED
        -	PARTIALLY_FAILED
        -	CANCELLED";
    }
  }

}
+171 −18

File changed.

Preview size limit exceeded, changes collapsed.