Commit af35b61d authored by Pietro Piscione's avatar Pietro Piscione
Browse files

SOL005 to SOL009, SOL0017, SOL023, SOL024, SOL027, SOL031, SOL033, SOL049

parent 6dea1ea0
Loading
Loading
Loading
Loading
Loading
+464 −21
Original line number Diff line number Diff line
@@ -182,6 +182,47 @@ definitions:
         $ref: "#/definitions/CmfInfo"
       
        
  CmfData:
   type: object
   description: > 
     This type provides input information related to CMF for certificate management.
   required:
     - endPoint
     - supportedProtocol
   properties:
      endPoint:
        description: >
          End point of CMF instance.
        type: object
        required:
        - ipAddress
        - link
        properties:
          ipAddress:
            description: >
              An IP address of this end point.
            $ref: "#/definitions/IpAddress"
          link:
            description: >
              A link to this end point.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
      supportedProtocol:
        type: array
        description: > 
          Supported protocol by CMF instance.
          Permitted values:
            * CMP
            * CMPv2
            * EST
            * SCEP
        minumumElement: 1
        items: 
          type: string
          enum:
            - CMP
            - CMPv2
            - EST
            - SCEP


  CmfInfo:
@@ -222,7 +263,7 @@ definitions:
            CMPv2
            EST
            SCEP
        minumumElement: 1
        minItems: 1
        items: 
            type: string
            enum:
@@ -262,12 +303,13 @@ definitions:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Number"


  CertBaseProfile:
  CertificateBaseProfile:
    type: object
    description: > 
      This type provides input information to override certificate base profile for certificate management.
      NOTE: At least one overriding attributes shall be present, otherwise shall be absent.
    minProperties: 2
      This type provides input information to override certificate 
      base profile for certificate management.
      NOTE: At least one overriding attributes shall be present, 
      otherwise shall be absent.
    required:
     - id
    properties:
@@ -319,19 +361,17 @@ definitions:
            type: string
        
        

  CertSubjectData:
    type: object
    
    description: > 
      This type provides input information related to subject of certificate.
      NOTE: At least one overriding attributes shall be present, otherwise shall be absent.
    properties:    
        minProperties: 1
        commonName:
          description: >
            Information of certification target subject FQDN. 
            Can be set empty when this certificate is used for encrypted communication using IP address. 
            Can be set empty when this certificate is used for 
            encrypted communication using IP address. 
            See note.
          type: string
        organization:
@@ -350,8 +390,6 @@ definitions:
          description: Information of certification contact email address. See note.
          type: string



  CreateNsRequest:
    type: object
    required:
@@ -372,6 +410,48 @@ definitions:
        description: >
          Human-readable description of the NS instance to be created.
        type: string
      certificateConfigurationData:
        description: >
          Configuration for certificate management such as
          certificate profile, information of CMF and security policy
          in this NS. It shall be present when using delegation
          mode, otherwise it shall be absent.
        $ref: "#/definitions/CertificateConfigurationData"
        
  CertificateConfigurationData:
    description: >
     This type represents the input information related to certificate management. 
    type: object
    required:
      - overridingCertificateProfile
    properties:
      overridingCertificateProfile:
        description: >
          Overriding certificate profile. This overrides the
          certificateBaseProfile provided in the VNFD, and
          the CA and CMF can additionally override aspects
          of this certificateBaseProfile at later point in the
          VNF lifecycle if necessary to meet operator
          security policy.
        type: array
        items:
          $ref: "#/definitions/CertificateBaseProfile"
                    
      securityPolicy:
        description: >
          Security policy to be satisfied for certificate.
        type: array
        minItems: 1
        items:
          $ref: "#/definitions/SecurityPolicy"
      cmfData:
        description: >
          Information for CMF. Shall be present in delegation mode.
        type: array
        minItems: 1
        items:
          #$ref: "#/definitions/CmfData"
          type: string
          
  CancelModeType:
    description: >
@@ -397,6 +477,67 @@ definitions:


  
  PaasServiceInfo:
    description: >
      This type provides information about a PaaS Service that is used 
      by a VNF instance or some other NS constituent. he PaasServiceInfo is 
      comprised of various sets of information. Some information comes from the 
      descriptors (e.g.,VNFD or NSD), other information comes from the PaaS Service
      assets provided by the NFVO to the VNFM, and other information is provided 
      as runtime information about the usage of the PaaS Service.

      NOTE: Either a "nsPaasServiceRequestId" or a "vnfPaasServiceRequestId" shall
      be provided, but not both.
    type: object
    required:
      - id
      - paasServiceId
      - paasServiceType
      - paasServiceHandle
    properties:
      id:
        description: >
         Identifier of this PaaS Service Information..
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      paasServiceId:
        description: >
         Identifier of the assigned PaaS Service as managed by the PaaS 
         Services Management (PSM) function.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      paasServiceType:
        description: >
         The type of PaaS Service. The value of this attribute is
         expected to be matched against values of the
         registered PaaS Services in the PSR.
        type: string
      paasServiceVersion:
        description: >
         Version of the PaaS Service. It shall be present if the
         PaaS Service is versioned
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
      nsPaasServiceRequestId:
        description: >
         Identifier of the PaaS Service request in the NSD that
         maps to the assigned PaaS Service. See note
        $ref: "#/definitions/IdentifierInNsd"
      vnfPaasServiceRequestId:
        description: >
         Identifier of the PaaS Service request in the VNFD
         that maps to the assigned PaaS Service. See note.
        $ref: "#/definitions/IdentifierInVnfd"
      paasServiceHandle:
        description: >
         A handle enabling the access and use of the PaaS
         Service by the NS constituent.
        $ref: "#/definitions/PaasServiceHandle"   
      additionalInfo:
        description: >
          Additional information which is specific to the PaaS
          Service, its type, and which is available from the PaaS
          Service instance
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
        
  

  PaasServiceHandle:
    description: >
@@ -429,6 +570,63 @@ definitions:
         and whether or not this attribute is available, is dependent on the type of the PaaS Service.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  MirroringInfo:
     description: >
       This type represents the runtime information that the NFVO holds about a Data Flow Mirroring. 
       
       NOTE: It is responsibility of the NFVO to map the mirroringIds exposed towards the API consumer
       on the Os-Ma-nfvo reference point with the corresponding identifiers of the data flow mirroring
       that are created towards the VIM.
     type: object
     required:
      - mirroringId
      - mirroringName
      - description
      - collectorDetails
      - vnfInstanceId
      - cpInstanceId
      - dataFlowData
     properties:
      mirroringId:
        description: >
          Identifier of the NS instance.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      mirroringName:
        description: >
          Name of Data Flow Mirroring.
        type: string
      description:
        description: >
          Information description of Data Flow Mirroring
        type: string
      collectorDetails:
        description: >
          Information about where the mirrored flow is to be delivered
        $ref: "#/definitions/CollectorDetails"
      vnfInstanceId:
        description: >
          Identifier of the VNF instance from where the data flows
          are requested to be mirrored.
        type: array
        minItems: 1
        items:
         $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      cpInstanceId:
        description: >
          Identifier of the CP instance from where the data flows
          are mirrored.
        type: array
        minItems: 1
        items:
         $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" 
      dataFlowData:
        description: >
          Information about the data flows to be mirrored
        type: array
        minItems: 1
        items:
         $ref: "#/definitions/DataFlowData"     
      

  NsInstance:
    description: >
@@ -473,15 +671,13 @@ definitions:
        description: >
          Describes version dependencies currently valid for the nested NS instance. Identifies versions 
          of descriptors of other constituents in the NSD upon which the nested NS depends. 
          The dependencies may be described for the NSD referenced in this NsInfo with nsdId and for 
          The dependencies may be described for the NSD referenced in this NsInstance with nsdId and for 
          NSDs with the same "nsdExtInvariantId".
          There shall not be more than one versionDependency present with the same dependentConstituentId.
          It may be present for the NsInfo of a nested NS. It shall not be present otherwise.
          It may be present for the NsInstance of a nested NS. It shall not be present otherwise.
        type: array
        items:
          $ref: "#/definitions/VersionDependency"
      
      
      nsdInfoId:
        description: >
          Identifier of the NSD information object on which the
@@ -586,6 +782,13 @@ definitions:
        type: array
        items:
          $ref: "#/definitions/WanConnectionInfo"
      dataFlowMirroringInfo:
        description: >
          Information related to Data Flow Mirroring associated to this NS instance
        type: array
        items:
          $ref: "#/definitions/MirroringInfo"
          
      _links:
        type: object
        description: Links to resources related to this resource.
@@ -2755,6 +2958,28 @@ definitions:
          items:
            $ref: "#/definitions/DataFlowMirroringData"

  DeployableModulesInConstituentVnf:
    description: >
     This type represents the input information to indicate the selected deployable
     modules of a VNF instance.
    type: object
    required:
      - profileId
      - selectedDeployableModule
    properties:
      profileId:
        description: >
         Indicates a profileId of a VNF instance where the
         selection of the deployable modules applies
        $ref: "#/definitions/IdentifierInNsd"
      selectedDeployableModule:
        description: >
         References a selected deployable module, as
         defined in the VNFD, for the VNF instances created
         from the VNF profile indicated in profileId attribute.
        type: array
        items:
         $ref: "#/definitions/IdentifierInVnf"

  ParamsForNestedNs:
    description: >
@@ -2808,6 +3033,13 @@ definitions:
          that the NFVO keeps about the profile.
          See note 3.
        $ref: "#/definitions/OverridingVersionDependency"
      deployableModulesInConstituentVnf:
        description: >
          Indicates the selected deployable modules of a VNF
          instance which is a constituent of the NS instance
        type: array
        items:
          $ref: "#/definitions/DeployableModulesInConstituentVnf"
      

  ParamsForVnf:
@@ -3220,6 +3452,64 @@ definitions:

        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"

  SelectVnfDeployableModuleData:
   description: >
    This type represents the information used to select the deployable modules 
    of an existing VNF instance. It is used to select deployable modules of a VNF
    instance that were previously not selected or to unselect deployable modules 
    of a VNF instance that were previously selected. The target size expressed 
    as a list of scale levels only refers to VNFCs that are instantiated as a 
    result of this operation. The NFVO shall then invoke the SelectVnfDeployableModules
    operation towards the appropriate VNFM.
    
    NOTE: Thus, the “select deployable modules of a VNF instance” NS update type cannot be used as a scale VNF
    operation to scale VNFCs that were already instantiated.
   type: object
   required:
    - vnfInstanceId
   properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      selectedDeployableModule:
        description: >
          References a selected deployable module, as defined
          in the VNFD, for the VNF instance. VNFCs based on
          VDUs that belong to deployable modules listed in this
          attribute will be instantiated if not already instantiated.
          VNFCs based on VDUs that belong to deployable
          modules not listed in this attribute and that were
          already instantiated will be terminated.
        type: array
        items:
         $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      targetScaleLevelInfo:
        description: >
          For each VNF scaling aspect, it defines the target scale level to which
          the VNF is to be scaled. If this attribute is not present or if there 
          are VDUs that belong to selected deployable modules that take no
          part in any of the scaling aspects indicated in this attribute, the 
          VNFCs based on those VDUs shall be instantiated according to the currently 
          valid VNF scale level or instantiation level. This attribute should only 
          contain scale level information of scaling aspects associated to VDUs that
          will be used to instantiate VNFCs as a result of this operation. If it 
          contains other scale level information it shall be ignored. See note.
          The VNF Provider defines in the VNFD whether or not a particular VNF 
          supports scaling according to this parameter. Such a property in the 
          VNFD applies for all instances of a particular VNF.
        type: array
        items:
          $ref: "#/definitions/VnfScaleInfo"
      additionalParam:
        description: >
          Additional parameters passed by the OSS/BSS as
          input to the Select VNF deployable modules operation,
          specific to the VNF being affected by the operation, as
          declared in the VNFD (see clause 7.1.5.14 in ETSI GS
          NFV IFA 011)
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
        
  UpdateNsRequest:
    description: >
      This operation supports the update of a NS instance operation.
@@ -3287,6 +3577,10 @@ definitions:
          * MODIFY_WAN_CONNECTION_INFO: Modify WAN related connectivity information.
          * CREATE_NS_VIRTUAL_LINK: Create an NsVirtualLink instance.
          * DELETE_NS_VIRTUAL_LINK: Delete an NsVirtualLink instance.
          * CREATE_DATA_FLOW_MIRRORING: Create a new data flow mirroring
          * DELETE_DATA_FLOW_MIRRORING: Delete an existing data flow mirroring
          * UPDATE_DATA_FLOW_MIRRORING: Update an existing data flow mirroring
          * SELECT_VNF_DEPL_MODULES: Select deployable modules of a VNF instance
        type: string
        enum:
          - ADD_VNF
@@ -3316,6 +3610,10 @@ definitions:
          - MODIFY_WAN_CONNECTION_INFO
          - CREATE_NS_VIRTUAL_LINK
          - DELETE_NS_VIRTUAL_LINK
          - CREATE_DATA_FLOW_MIRRORING
          - DELETE_DATA_FLOW_MIRRORING
          - UPDATE_DATA_FLOW_MIRRORING
          - SELECT_VNF_DEPL_MODULES
      addVnfIstance:
        description: >
          Identifies an existing VNF instance to be added to the
@@ -3537,6 +3835,43 @@ definitions:
          If not present, default value applies.
          See notes 6, 7, 8, 9 and 10.
        $ref: "#/definitions/FeasibilityCheckReserveType"
      createDataFlowMirroring:
        description: >
          Information of the Data Flow Mirroring that are
          associated with the NS instance.  This parameter 
          shall be present only if updateType = CREATE_DATA_FLOW_MIRRORING
        type: array
        items:
          $ref: "#/definitions/CreateDataFlowMirroring"
      deleteDataFlowMirroringId:
        description: >
          Identifier of the "DataFlowMirroringData" structure that
          are associated with the NS instance to be deleted. This
          parameter shall be present only if updateType =
          DELETE_DATA_FLOW_MIRRORING
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      updateDataFlowMirroring:
        description: >
          Information on the Data Flow Mirroring associated to the
          NS instance to be updated. This parameter shall be
          present only if updateType =
          UPDATE_DATA_FLOW_MIRRORING
        type: array
        items:
          $ref: "#/definitions/UpdateDataFlowMirroring"
        
      selectVnfDeployableModuleData:
       description: >
          Specify the data needed for selecting deployable
          modules of a VNF instance. This parameter shall be
          present only if updateType=
          SELECT_VNF_DEPL_MODULES.
       type: array
       items:
          $ref: "#/definitions/SelectVnfDeployableModuleData"



  InstantiateVnfData:
@@ -4641,7 +4976,7 @@ definitions:
      This type provides information about added, deleted and modified VNFs.

      NOTE: At least one of the attributes "changedVnfInfo", "changedExtConnectivity"
      or "modificationsTriggeredByVnfPkgChange" shall be present. Not more than one
      or "modificationsTriggeredByVnfPkgChange" or “changedCertificateInfo” shall be present. Not more than one
      of "changedVnfInfo" and "modificationsTriggeredByVnfPkgChange" shall be present.
    type: object
    required:
@@ -4720,7 +5055,8 @@ definitions:
      changedInfo:
        description: >
          Information about the changed VNF instance
          information, including VNF configurable properties,if applicable.
          information, including VNF configurable properties,
          and certificate content if applicable.
          When the "changedInfo" attribute is present, 
          either the "changedVnfInfo" attribute or the
          "changedExtConnectivity" attribute or both shall be present.
@@ -4760,6 +5096,113 @@ definitions:
              Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG".
              See note.
            $ref: "#/definitions/ModificationsTriggeredByVnfPkgChange"
          changedCertificateInfo:
            description: >
              Information about changed certificate, if
              applicable. See note
            type: array
            items:
              $ref: "#/definitions/CertificateInfo"
  
  CertificateContent:
    description: >
      This type provides input information related to certificate content. 
      
      NOTE : The CertificateDesc data type is defined in clause 7.1.19.2 of 
      ETSI GS NFV IFA 011
    type: object
    required:
      - id
      - certficateDescId
      - certificateType
    properties:
      id:
        description: >
          Identifier of this certificate.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      certficateDescId:
        description: >
          Identifier of certificate description in VNFD to be used to issue this 
          certificate. See note.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      certificateType:
        description: >
          Type of this certificate.
          Values:
          * VNFCI_CERT
          * VNFOAM_CERT
        type: string
        enum:
          - VNFCI_CERT
          - NFOAM_CERT
      supportedCertificateManagement:
        description: >
          Describes supported certificate management information.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
      version:
        description: >
          Version of this certificate
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
      serialNumber:
        description: >
          Serial number of this certificate
        type: integer
      signatureAlgorithm:
        description: >
          Algorithm of this certificate’s signature.
        type: string
      issuer:
        description: >
          Issuer of this certificate.
        type: string
      notBefore:
        description: >
          Start date of valid period for this certificate.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      notAfter:
        description: >
          End date of valid period for this certificate.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      subject:
        description: >
          Subject of this certificate.
        type: string
      publicKeyAlgorithm:
        description: >
          Algorithm of this certificate’s public key
        type: string         
      certificateExtensions:
        description: >
          Extension of this certificate.
        type: string             


  CertificateInfo:
    description: >
      This type provides input information related to certificate and certificate management.
    type: object
    required:
      - id
    properties:
      id:
        description: >
          Identifier of this certificate information.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      certificateConfigurationInfo:
        description: >
          Configuration for certificate management such as
          certificate profile, information of CMF and security
          policy
        $ref: "#/definitions/CertificateConfigurationInfo"
      certificateContents:
        description: >
          Information for contents of issued certificates. The
          information contained in this attribute may be updated
          over time during the VNF LCM, e.g. certificate(s)
          renewal.
        type: array
        items:
          $ref: "#/definitions/CertificateContent"

  AffectedPnf:
    description: >