Newer
Older
"required": ["connectionType", "interfaceType", "interfaceTagging", "encapsulationType"],
"properties": {
"connectionType": {
"description": "The type of connection to be established on the connectivity service point. Permitted values: - CSE: defined by the characteristics of the existing referred connectivity service point. - AGGREGATE_CSE: create an aggregation of the connectivity service endpoints.\n",
"type": "string",
"enum": ["CSE", "AGGREGATE_CSE"]
},
"interfaceType": {
"description": "To indicate whether to create logical interfaces on the referred connectivity service endpoint or new aggregated connectivity service endpoint. Permitted values: - PARENT: use the mapped interface to the connectivity service endpoint as is, i.e., do not create logical interfaces. - LOGICAL: create logical interfaces.\n",
"type": "string",
"enum": ["PARENT", "LOGICAL"]
},
"interfaceTagging": {
"description": "The type of frames to forward on the connectivity service point. Permitted values: - UNTAGGED: an interface where frames are not tagged. - TAGGED: an interface configured to forward tagged frames (i.e., enabled for VLAN tagging).\n",
"type": "string",
"enum": ["UNTAGGED", "TAGGED"]
},
"encapsulationType": {
"description": "The type of encapsulation. If the interfaceTagging=\"TAGGED\", either \"VLAN\" or \"VXLAN\" shall be set. Permitted values: - ETH: generic Ethernet encapsulation. - VLAN: encapsulation based on VLAN. - VXLAN: encapsulation based on VXLAN.\n",
"type": "string",
"enum": ["ETH", "VLAN", "VXLAN"]
},
"vlanTaggingType": {
"description": "Type of encapsulation method for VLAN tagging. Shall be present if interfaceTagging=\"TAGGED\" and encapsulationType=\"VLAN\". Permitted values: - DOT1Q: used when packets on the CSE are encapsulated with one or a set of customer VLAN identifiers. - QINQ: used when packets on the CSE are encapsulated with multiple customer VLAN identifiers and a single service VLAN identifier.\n- QINANY: used when packets on the CSE have no specific customer VLAN and a service VLAN identifier is used.\n",
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
"type": "string",
"enum": ["DOT1Q", "QINQ", "QINANY"]
},
"wanSegmentIds": {
"description": "Segment identifiers to pass on the tagged interface. Shall be present if encapsulationType=\"VLAN\" or “VXLAN\".\n",
"type": "object",
"required": ["wanSegmentIdValue"],
"properties": {
"wanSegmentIdValue": {
"description": "Identifier of the network segment (e.g., VLAN id or VNI).\n",
"type": "string"
},
"wanSegmentIdUpperRange": {
"description": "Identifier of the upper range network segment, in case the \"wanSegmentIds\" is used to define a range.\n",
"type": "string"
}
}
},
"vxlanConfig": {
"description": "Additional configuration needed when using VXLAN encapsulation. Shall be present if interfaceTagging=\"TAGGED\" and encapsulationType=\"VXLAN\".\n",
"type": "object",
"required": ["peerMode"],
"properties": {
"peerMode": {
"description": "Type of VXLAN access mode. Default value is \"STATIC\".\nPermitted values: - STATIC - BGP_EVPN\n",
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
"type": "string",
"enum": ["STATIC", "BGP_EVPN"]
},
"peers": {
"description": "List of IP addresses of VTEP peers when using static mode.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
}
},
"lagInterfaceData": {
"description": "Information for setting up a LAG interface aggregating multiple connectivity service endpoints.\n",
"type": "object",
"required": ["aggregatedEndpoints", "lacpActivation", "lacpConfig"],
"properties": {
"aggregatedEndpoints": {
"description": "List of the connectivity service endpoints that are to be aggregated. Shall be present if connectionType=\"AGGREGATE_CSE\". In case of aggregating connectivity service endpoints, only one SiteToWanLayer2ProtocolData shall be provided for the whole set of aggregated endpoints.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
},
"lacpActivation": {
"description": "Indicates whether to activate LACP on the interface. If \"TRUE\", the LACP is to be activated, or \"FALSE\" otherwise. Default value is \"FALSE\".\n",
"type": "boolean"
},
"lacpConfig": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
}
}
},
"layer2ControlProtocol": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
}
}
},
"mtuL2": {
"description": "Maximum Transmission Unit (MTU) that can be forwarded at layer 2 (in bytes). Default value is \"1500\" (bytes).\n",
"type": "number"
},
"virtualRoutingAndForwarding": {
"description": "Configuration related to the L2 virtual routing and forwarding (MAC-VRF).\n",
"type": "object",
"required": ["macVrfName"],
"properties": {
"macVrfName": {
"description": "Name (or identifier) of the MAC-VRF instance.\n",
"type": "string"
}
}
},
"forwardingConfig": {
"description": "Information related to the forwarding of the VN in the NFVI-PoP to the connectivity service endpoint, if information about the VN to \"stitch\" is already known. . by the OSS/BSS. Shall not be provided otherwise, in which case the NFVO will infer the forwarding configuration based on the NS VL, or external VL, or externally-managed VL provisioning.\n",
"type": "object",
"oneOf": [{
"required": ["networkResources"]
}, {
"required": ["vnSegmentIds"]
}],
"properties": {
"networkResources": {
"description": "Reference to the VN resource to be forwarded into/from the MSCS. See note.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\nNOTE 1:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the CISM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. When the container infrastructure service is a Kubernetes® instance the vimLevelResourceType is the type of resource, as would correspond to the ‘kind’ field if the resource is declared in its own Kubernetes® manifest, e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition. NOTE 2:\tWhen the container infrastructure service is a Kubernetes® instance the resourceId shall be populated in the following way: * For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide per resource type. * For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, i.e. the value of the ‘claimName’ field in the Kubernetes® manifest, or a compound name built by Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own manifest. * For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of the ‘metadata.name’ field in Kubernetes® manifest. \n",
"type": "object",
"required": ["resourceId"],
"properties": {
"vimId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
},
"vimLevelResourceType": {
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
"description": "Additional resource information which is specific to this resource and its type, and which is available from the VIM or the CISM or the resource provider. See note 1.\n",
"type": "string"
},
"vimLevelAdditionalResourceInfo": {
"description": "This type represents additional resource information which resource and resource type specific, and which is available from the VIM or the CISM or the resource provider. NOTE:\tAt least one attribute shall be present. \n",
"type": "object",
"properties": {
"hostName": {
"description": "Name of the host where the resource is allocated. It shall be present for compute resources in the scope of the CISM and shall be absent otherwise. See note.\n",
"type": "string"
},
"persistentVolume": {
"description": "Name of the persistent volume to which the persistent volume claim representing the storage resource is bound. It may be present for storage resources in the scope of the CISM and shall be absent otherwise. See note.\n",
"type": "string"
},
"additionalInfo": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
}
}
},
"containerNamespace": {
"description": "The value of the namespace in which the MCIO corresponding to the resource is deployed. This attribute shall be present if the resource is managed by a CISM and it shall be absent otherwise.\n",
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
"type": "string"
}
}
}
},
"vnSegmentIds": {
"description": "Identifiers of the network segments of the VN resources to be forwarded into/from the MSCS.\n",
"type": "object",
"required": ["vnSegmentIdValue"],
"properties": {
"vnSegmentIdValue": {
"description": "Identifier of the network segment.\n",
"type": "string"
},
"vnSegmentIdUpperRange": {
"description": "Identifier of the upper range network segment, in case the \"vnSegmentIds\" is used to define a range.\n",
"type": "string"
}
}
}
}
}
}
},
"siteToWanLayer3ProtocolData": {
"description": "This type provides information about Layer 3 protocol specific information for the stitching of the intra-site VN to the multi-site connectivity service over the WAN. It shall comply with the provisions defined in Table 6.5.3.86-1.\n",
"type": "object",
"required": ["routingInfo"],
"properties": {
"logicalInterfaceIpAddress": {
"description": "IP addressing information associated to a logical interface. Shall be present if the \"interfaceType\" of the SiteToWanLayer2ProtocolData is equal to \"LOGICAL\".\n",
"type": "object",
"required": ["ipAddress", "associatedSegmentId"],
"properties": {
"ipAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"associatedSegmentId": {
"description": "The associated segment identifier that has triggered the creation of the logical interface. The value shall be one of the values listed in the \"wanSegmentIds\" of the \"siteToWanLayer2ProtocolData\".\n",
"type": "string"
}
}
},
"routingInfo": {
"description": "The routing information that is activated on the connectivity service endpoint. More than one \"routingInfo\" is allowed to enable stacking different routing protocols (e.g., one routing protocol for IPv4 and another one for IPv6).\n",
"type": "object",
"required": ["routingProtocol", "routingAddressFamily"],
"properties": {
"routingProtocol": {
"description": "The routing protocol that is activated on the connectivity service endpoint. Permitted values: - BGP: used for dynamic routing BGPv4. - RIP: used for dynamic routing RIPv2. - OSPF: used for dynamic routing (OSPF version 2 for IPv4; and OSPF version 3 for IPv6). - STATIC: used for static routing. - DIRECT: used when the NFVI-PoP network is directly connected to the WAN provider network. - VRRP: used when the NFVI-PoP network is directly connected to the WAN provider network with virtual router redundancy protocol support (VRRP).\n",
"type": "string",
"enum": ["BGP", "RIP", "OSPF", "STATIC", "DIRECT", "VRRP"]
},
"staticRouting": {
"description": "Defines a static route. It shall only be present if the routingProtocol=\"STATIC\".\n",
"type": "object",
"required": ["ipVersion", "ipPrefix", "prefixSize", "nextHop"],
"properties": {
"ipVersion": {
"description": "The IP version applicable to the routing entry. Permitted values: - IPV4 - IPV6\n",
"type": "string",
"enum": ["IPV4", "IPV6"]
},
"ipPrefix": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"prefixSize": {
"description": "The IP prefix size.\n",
"type": "number"
},
"nextHop": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"routingAddressFamily": {
"description": "The IP version applicable to the dynamic routing protocol. Shall be present for dynamic routing protocols. Permitted values: - IPV4 - IPV6\n",
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
"type": "string",
"enum": ["IPV4", "IPv6"]
},
"ospfRouting": {
"description": "Defines parameters for OSPF routing. It shall only be present if the routingProtocol=\"OSPF\".\n",
"type": "object",
"required": ["areaId"],
"properties": {
"areaId": {
"description": "The routing area identifier, e.g., a number or an IP address.\n",
"type": "string"
}
}
},
"bgpRouting": {
"description": "Defines parameters for BGP routing. It shall only be present if the routingProtocol=\"BGP\".\n",
"type": "object",
"required": ["bgpAs"],
"properties": {
"bgpAs": {
"description": "The Autonomous System (AS) identification applicable to the BGP routing info entry.\n",
"type": "object"
},
"bgpNeighbour": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"bgpAdditionalParam": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
}
}
},
"routeMapsDistribution": {
"description": "Maps of routes that are permitted or denied for redistribution.\n",
"type": "object",
"required": ["policy", "sequence", "matchAndSetRule"],
"properties": {
"policy": {
"description": "The policy to apply to the route distribution.\nPermitted values: - PERMIT - DENY\n",
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
"type": "string",
"enum": ["PERMIT", "DENY"]
},
"sequence": {
"description": "Sequence or index number assigned to the route-map.\n",
"type": "number"
},
"matchAndSetRule": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
}
}
}
}
},
"mtuL3": {
"description": "Maximum Transmission Unit (MTU) that can be forwarded at layer 3 (in bytes). Default value is \"1500\" (bytes).\n",
"type": "number"
},
"virtualRoutingAndForwarding": {
"description": "Configuration related to the virtual routing and forwarding (VRF).\n",
"type": "object",
"required": ["vrfName"],
"properties": {
"vrfName": {
"description": "Name (or identifier) of the VRF instance.\n",
"type": "string"
}
}
},
"bfdConfig": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
}
}
}
}
}
}
}
}
}
}
},
"_links": {
"type": "object",
"description": "Links to resources related to this resource.",
"required": ["self"],
"properties": {
"self": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"type": "string",
"format": "url"
}
}
},
"nestedNsInstances": {
"description": "Links to resources related to this notification.\n",
"type": "array",
"items": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"type": "string",
"format": "url"
}
}
}
},
"vnfSnapshotInfos": {
"description": "Links to the VNF snapshots associated to VNF instances which are part of this NS instance.\n",
"type": "array",
"items": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"type": "string",
"format": "url"
}
}
}
},
"instantiate": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"type": "string",
"format": "url"
}
}
},
"terminate": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"type": "string",
"format": "url"
}
}
},
"update": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"type": "string",
"format": "url"
}
}
},
"scale": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"type": "string",
"format": "url"
}
}
},
"heal": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"type": "string",
"format": "url"
}
}
}
}
}
}