Newer
Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli
committed
definitions:
moscatelli
committed
NsdInfoModifications:
type: object
description: >
This type represents attribute modifications for an individual NS
descriptor resource based on the NsdInfo data type. The attributes of
NsdInfo that can be modified are included in the NsdInfoModifications
data type.NOTE: At least one of the attributes - nsdOperationalState and
userDefinedData - shall be present.
properties:
nsdOperationalState:
$ref: "#/definitions/NsdOperationalStateType"
userDefinedData:
description: >
Modifications of the userDefinedData attribute in NsdInfo
data type. See note. If present, these modifications shall be applied
according to the rules of JSON Merge PATCH (see IETF RFC 7396 [25]).
NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
NsdInfo:
moscatelli
committed
type: object
moscatelli
committed
required:
moscatelli
committed
- id
- nsdOnboardingState
- nsdOperationalState
- nsdUsageState
- _links
moscatelli
committed
properties:
id:
description: >
Identifier of the on boarded individual NS descriptor
resource. This identifier is allocated by the NFVO.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
nsdId:
description: >
This identifier, which is allocated by the NSD
designer, identifies the NSD in a globally unique
way. It is copied from the NSD content and shall be
present after the NSD content is on-boarded.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
nsdName:
moscatelli
committed
type: string
moscatelli
committed
description: >
Name of the on boarded NSD. This information is copied from the
NSD content and shall be present after the NSD content is on-boarded.
moscatelli
committed
nsdVersion:
description: >
Version of the on-boarded NSD. This information is
copied from the NSD content and shall be present
after the NSD content is on-boarded.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
moscatelli
committed
nsdDesigner:
moscatelli
committed
type: string
moscatelli
committed
description: >
Designer of the on-boarded NSD. This information is copied
from the NSD content and shall be present after the NSD content is on-boarded.
moscatelli
committed
nsdInvariantId:
description: >
This identifier, which is allocated by the NSD
designer, identifies an NSD in a version independent
manner. This information is copied from the NSD
content and shall be present after the NSD content is
on-boarded.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfPkgIds:
description: >
Identifies the VNF package for the VNFD referenced
by the on-boarded NS descriptor resource.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
pnfdInfoIds:
description: >
Identifies the PnfdInfo element for the PNFD
referenced by the on-boarded NS descriptor
resource.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
nestedNsdInfoIds:
description: >
Identifies the NsdInfo element for the nested NSD
referenced by the on-boarded NS descriptor
resource.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
archiveSecurityOption:
description: >
Signals the security option used by the NSD archive as defined
in clause 5.1 of ETSI GS NFV SOL 007.
Valid values: OPTION_1, OPTION_2
type: string
enum:
- OPTION_1
- OPTION_2
signingCertificate:
description: >
The singleton signing certificate if it is included as a file in the NSD archive.
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
artifacts:
description: >
Information about NSD archive artifacts contained in the NSD archive.
This attribute shall not be present before the NSD archive content
is on-boarded. Otherwise, this attribute shall be present if the NSD
archive contains artifacts.
type: array
items:
$ref: "#/definitions/NsdArchiveArtifactInfo"
moscatelli
committed
nsdOnboardingState:
description: >
On boarding state of the individual NS descriptor resource.
$ref: "#/definitions/NsdOnboardingStateType"
onboardingFailureDetails:
description: >
Failure details of current on boarding procedure. See
clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails"
moscatelli
committed
structure.
It shall be present when the "nsdOnboardingState"
attribute is "ERROR", i.e. the uploading or processing has failed in NFVO,
unless it has been requested to be excluded via an attribute selector.
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
moscatelli
committed
nsdOperationalState:
description: >
Operational state of the individual NS descriptor
resource. This attribute can be modified with the
PATCH method.
$ref: "#/definitions/NsdOperationalStateType"
nsdUsageState:
description: >
Usage state of the individual NS descriptor resource.
$ref: "#/definitions/NsdUsageStateType"
userDefinedData:
description: >
User defined data for the individual NS descriptor
resource. This attribute can be modified with the
PATCH method.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
_links:
moscatelli
committed
type: object
moscatelli
committed
required:
moscatelli
committed
- self
- nsd_content
moscatelli
committed
description: >
moscatelli
committed
Links to resources related to this resource.
moscatelli
committed
properties:
self:
description: >
moscatelli
committed
URI of this resource.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
moscatelli
committed
nsd_content:
description: >
moscatelli
committed
Link to the NSD content resource.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
moscatelli
committed
description: >
moscatelli
committed
This type represents a response for the query NSD operation.
moscatelli
committed
CreateNsdInfoRequest:
type: object
moscatelli
committed
properties:
userDefinedData:
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
description: >
This type creates a completely new NS descriptor resource.
moscatelli
committed
PnfdInfoModifications:
type: object
moscatelli
committed
required:
- userDefinedData
moscatelli
committed
properties:
userDefinedData:
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
description: >
moscatelli
committed
This type represents attribute modifications for an individual PNF
moscatelli
committed
descriptor resource based on the "PnfdInfo" data type. The attributes of
"PnfdInfo" that can be modified are included in the "PnfdInfoModifications"
moscatelli
committed
data type.
moscatelli
committed
PnfdInfo:
moscatelli
committed
type: object
moscatelli
committed
required:
moscatelli
committed
- id
- pnfdOnboardingState
- pnfdUsageState
- _links
moscatelli
committed
properties:
id:
description: >
Identifier of the on-boarded individual PNF
descriptor resource. This identifier is allocated by
the NFVO.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
pnfdId:
description: >
This identifier, which is managed by the PNFD
designer, identifies the PNFD in a globally unique way.
It is copied from the PNFD content and shall
be present after the PNFD content is on-boarded.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
pnfdName:
description: >
Name of the on-boarded PNFD. This information
is copied from the PNFD content and shall be
present after the PNFD content is on-boarded.
moscatelli
committed
type: string
moscatelli
committed
pnfdersion:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
moscatelli
committed
pnfdProvider:
description: >
Provider of the on-boarded PNFD. This information is copied from
the PNFD content and shall be present after the PNFD content is on-boarded.
moscatelli
committed
type: string
moscatelli
committed
pnfdInvariantId:
description: >
Identifies a PNFD in a version independent
manner. This attribute is invariant across versions
of PNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
archiveSecurityOption:
description: >
Signals the security option used by the PNFD archive as defined
in clause 5.1 of ETSI GS NFV SOL 004.
Valid values: OPTION_1, OPTION_2
type: string
enum:
- OPTION_1
- OPTION_2
signingCertificate:
description: >
The singleton signing certificate if it is included as a file in the PNFD archive.
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
artifacts:
description: >
Information about PNFD archive artifacts contained in the PNFD archive.
This attribute shall not be present before the PNFD archive content is
on-boarded. Otherwise, this attribute shall be present if the PNFD archive
contains artifacts.
type: array
items:
$ref: "#/definitions/PnfdArchiveArtifactInfo"
moscatelli
committed
pnfdOnboardingState:
description: >
On-boarding state of the individual PNF descriptor resource.
$ref: "#/definitions/PnfdOnboardingStateType"
onboardingFailureDetails:
description: >
Failure details of current on-boarding procedure.
See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure.
moscatelli
committed
It shall be present when the
pnfdOnboardingState attribute is "ERROR", i.e. the uploading or processing has failed
in the NFVO, unless it has been requested to be excluded via an attribute selector.
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
moscatelli
committed
pnfdUsageState:
description: >
Usage state of the individual PNF descriptor resource.
$ref: "#/definitions/PnfdUsageStateType"
userDefinedData:
description: >
User defined data for the individual PNF descriptor resource.
This attribute can be modified with the PATCH method.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
_links:
required:
moscatelli
committed
- pnfd_content
- self
type: object
moscatelli
committed
description: >
Links to resources related to this resource.
moscatelli
committed
properties:
self:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
moscatelli
committed
pnfd_content:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
moscatelli
committed
description: >
moscatelli
committed
This type represents a response for the query PNFD operation.
rameshnaraya
committed
moscatelli
committed
CreatePnfdInfoRequest:
type: object
moscatelli
committed
properties:
userDefinedData:
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
description: >
User-defined data for the PNF descriptor resource to be created.
It shall be present when the user defined data is set for
the individual PNF descriptor resource to be created.
moscatelli
committed
NsdmSubscriptionRequest:
type: object
moscatelli
committed
required:
moscatelli
committed
- callbackUri
moscatelli
committed
properties:
moscatelli
committed
filter:
$ref: "#/definitions/NsdmNotificationsFilter"
callbackUri:
type: string
description: >
The URI of the endpoint to send the notification to.
authentication:
description: >
Authentication parameters to configure the use of Authorization when sending
notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires authorization of notifications.
moscatelli
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
moscatelli
committed
description: >
moscatelli
committed
This type represents a subscription request related to notifications
about NSD management.
moscatelli
committed
NsdmSubscription:
type: object
moscatelli
committed
required:
moscatelli
committed
- id
- callbackUri
- _links
moscatelli
committed
properties:
moscatelli
committed
id:
description: >
Identifier of this subscription resource.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
filter:
description: >
Filter settings for this subscription, to define the subset
of all notifications this subscription relates to.
A particular notification is sent to the subscriber if the filter
matches, or if there is no filter.
$ref: "#/definitions/NsdmNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
_links:
type: object
description: >
Links to resources related to this resource.
properties:
self:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
moscatelli
committed
description: >
moscatelli
committed
This type represents a subscription related to notifications about NSD management.
moscatelli
committed
NsdmNotificationsFilter:
type: object
description: >
This type represents a subscription filter related to notifications
about NSD management. It shall comply with the provisions defined in Table
5.5.3.2-1 of GS NFV-SOL 005. At a particular nesting level in the filter structure,
the following applies: All attributes shall match in order for the filter
to match (logical "and" between different filter attributes). If an attribute
is an array, the attribute shall match if at least one of the values in the
array matches (logical "or" between the values of one filter attribute).
NOTE 1: The attributes "nsdId" and "nsdInfoId" are alternatives to reference to a particular NSD in a filter.
They should not be used both in the same filter instance, but one alternative should be chosen.
NOTE 2: The attributes "pnfdId" and "pnfdInfoId" are alternatives to reference to a particular PNFD in a filter.
They should not be used both in the same filter instance, but one alternative should be chosen.
moscatelli
committed
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
properties:
notificationTypes:
description: >
Match particular notification types. Permitted values: NsdOnBoardingNotification,
NsdOnboardingFailureNotification, NsdChangeNotification, NsdDeletionNotification
PnfdOnBoardingNotification, PnfdOnBoardingFailureNotification, PnfdDeletionNotification.
The permitted values of the "notificationTypes" ] attribute are spelled
exactly as the names of the notification types to facilitate automated
code generation systems.
type: array
items:
type: string
enum:
- NsdOnBoardingNotification
- NsdOnboardingFailureNotification
- NsdChangeNotification
- NsdDeletionNotification
- PnfdOnBoardingNotification
- PnfdOnBoardingFailureNotification
- PnfdDeletionNotification
nsdInfoId:
description: >
Match the NsdInfo identifier which is allocated by the NFVO.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdId:
description: >
Match the NSD identifier, which is allocated by the NSD designer.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdName:
description: >
Match the name of the on boarded NSD.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
nsdVersion:
description: >
Match the NSD version listed as part of this attribute.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
nsdDesigner:
description: >
Match the NSD designer of the on-boarded NSD.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
nsdInvariantId:
description: >
Match the NSD invariant identifier which is allocated
by the NSD designer and identifies an NSD in a
version independent manner.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfPkgIds:
description: >
Match VNF packages with a package identifier listed
in the attribute.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfdInfoIds:
description: >
Match the PnfdInfo identifier for the PNFD
referenced by the on-boarded NSD.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nestedNsdInfoIds:
description: >
Match the NsdInfo identifier for the nested NSD
referenced by the on-boarded NSD.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdOnboardingState:
description: >
Match particular on-boarding state of the NSD.
type: array
items:
$ref: "#/definitions/NsdOnboardingStateType"
nsdOperationalState:
description: >
Match particular operational state of the on-boarded NSD.
type: array
items:
$ref: "#/definitions/NsdOperationalStateType"
nsdUsageState:
description: >
Match particular usage state of the on-boarded NSD.
type: array
items:
$ref: "#/definitions/NsdUsageStateType"
pnfdId:
description: >
Match the PNFD identifier which is copied from the PNFD content.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfdName:
description: >
Match the name of the on-boarded PNFD.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
pnfdVersion:
description: >
Match the PNFD designer of the on-boarded PNFD.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
pnfdProvider:
description: >
Match the provider of the on-boarded PNFD.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
pnfdInvariantId:
description: >
Match the PNFD in a version independent manner.
type: array
items:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfdOnboardingState:
description: >
Match particular on-boarding state of the PNFD.
type: array
items:
$ref: "#/definitions/PnfdOnboardingStateType"
pnfdUsageState:
description: >
Match the usage state of the individual PNF descriptor resource.
type: array
items:
$ref: "#/definitions/PnfdUsageStateType"
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
NsdArchiveArtifactInfo:
type: object
description: >
This type represents an artifact contained in an NSD archive.
It shall comply with provisions defined in Table 5.5.3.5-1.
required:
- artifactPath
- checksum
properties:
artifactPath:
description: >
Path in the NSD archive, which identifies the artifact and
also allows to access a copy of the artifact.
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
checksum:
description: >
Checksum of the artifact file.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum"
metadata:
description: >
The metadata of the artifact that are available in the NSD Archive,
such as Content type, size, creation date, etc.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
PnfdArchiveArtifactInfo:
type: object
description: >
This type represents an artifact contained in a PNFD archive.
It shall comply with provisions defined in Table 5.5.3.6-1.
required:
- artifactPath
- checksum
properties:
artifactPath:
description: >
Path in the PNFD archive, which identifies the artifact and
also allows to access a copy of the artifact.
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
checksum:
description: >
Checksum of the artifact file.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum"
nonManoArtifactSetId:
description: >
Non-MANO artifact set identifier of the non-MANO artifact set
to which the artifact belongs, as defined in clause 4.3.7 of
ETSI GS NFV-SOL 004. Shall be provided if the artifact is
a non-MANO artifact, and shall be omitted otherwise.
$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
metadata:
description: >
The metadata of the artifact that are available in the PNFD Archive,
such as Content type, size, creation date, etc.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
NsdOperationalStateType:
type: string
description: >
The enumeration NsdOperationalStateType shall comply with the provisions
defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational
state of the resource.
ENABLED = The operational state of the resource is enabled.
DISABLED = The operational state of the resource is disabled.
enum:
- ENABLED
- DISABLED
NsdUsageStateType:
type: string
description: >
The enumeration NsdUsageStateType shall comply with the provisions
defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It indicates the usage state
of the resource.IN_USE = The resource is in use.NOT_IN_USE = The resource
is not-in-use.
enum:
- IN_USE
- NOT_IN_USE
NsdOnboardingStateType:
type: string
description: >
The enumeration NsdOnboardingStateType shall comply with the provisions
defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding
state of the NSD.
CREATED = The NSD information object has been created.
moscatelli
committed
UPLOADING = The associated NSD content is being uploaded.
PROCESSING = The associated NSD content is being processed, e.g. validation.
ONBOARDED = The associated NSD content has been on-boarded.
ERROR = There was an error during upload or processing of the NSD content.
moscatelli
committed
enum:
- CREATED
- UPLOADING
- PROCESSING
- ONBOARDED
moscatelli
committed
PnfdOnboardingStateType:
type: string
description: >
The enumeration PnfdOnboardingStateType shall comply with the provisions
defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state
of the individual PNF descriptor resource.
CREATED = The PNF descriptor resource has been created.
moscatelli
committed
UPLOADING = The associated PNFD content is being uploaded.
PROCESSING = The associated PNFD content is being processed, e.g. validation.
ONBOARDED = The associated PNFD content has been on-boarded.
ERROR = There was an error during upload or processing of the associated PNFD content.
moscatelli
committed
enum:
- CREATED
- UPLOADING
- PROCESSING
- ONBOARDING
moscatelli
committed
PnfdUsageStateType:
type: string
description: >
The enumeration PnfdUsageStateType shall comply with the provisions
defined in Table 5.5.4.7-1 of GS NFV-SOL005. It indicates the usage state
of the resource.IN-USE = The resource is in use.NOT_IN_USE = The resource
is not-in-use.
enum:
- IN_USE
- NOT_IN_USE