nsd - Programmers API Reference
Schema Globals
| Global Schema Type | rw_ypbc_RwNsd_Nsd_t_schema |
| Global Schema Pointer | rw_ypbc_RwNsd_Nsd_g_schema |
nsd data
nsd:nsd-catalog
Key Identifiers:| XPath Path | /nsd:nsd-catalog |
| XPath Keyed Path | /nsd:nsd-catalog |
| RW.REST URI Path | /nsd:nsd-catalog |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog |
Fields
| Name | Type | Description |
|---|---|---|
| nsd | LIST |
nsd:nsd
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING'] |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the NSD. |
| name | STRING | NSD name. |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Vendor of the NSD. |
| logo | STRING | File path for the vendor specific logo. For example icons/mylogo.png. The logo should be part of the network service |
| description | STRING | Description of the NSD. |
| version | STRING | Version of the NSD |
| connection-point | LIST | List for external connection points. Each NS has one or more external connection points. As the name implies that external connection points are used for connecting the NS to other NS or to external networks. Each NS exposes these connection points to the orchestrator. The orchestrator can construct network service chains by connecting the connection points between different NS. |
| scaling-group-descriptor | LIST | scaling group descriptor within this network service. The scaling group defines a group of VNFs, and the ratio of VNFs in the network service that is used as target for scaling action |
| vnffgd | LIST | List of VNF Forwarding Graph Descriptors (VNFFGD). |
| ip-profiles | LIST | List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link |
| initial-service-primitive | LIST | Initial set of service primitives for NSD. |
| terminate-service-primitive | LIST | Set of service primitives during termination for NSD. |
| input-parameter-xpath | LIST | List of xpaths to parameters inside the NSD the can be customized during the instantiation. |
| parameter-pool | LIST | Pool of parameter values which must be pulled from during configuration |
| key-pair | LIST | Used to configure the list of public keys to be injected as part of ns instantiation |
| user | LIST | List of users to be added through cloud-config |
| vld | LIST | |
| constituent-vnfd | LIST | List of VNFDs that are part of this network service. |
| placement-groups | LIST | List of placement groups at NS level |
| vnf-dependency | LIST | List of VNF dependencies. |
| monitoring-param | LIST | |
| service-primitive | LIST | Network service level service primitives. |
| control-param | LIST | List of control parameters to manage and update the running configuration of the VNF |
| action-param | LIST | List of action parameters to control VNF |
| meta | STRING | Any meta-data needed by the UI |
| config-parameter-map | LIST | A mapping of VNF config parameter requests and sources within this network service |
nsd:connection-point
List for external connection points. Each NS has one or more external connection points. As the name implies that external connection points are used for connecting the NS to other NS or to external networks. Each NS exposes these connection points to the orchestrator. The orchestrator can construct network service chains by connecting the connection points between different NS.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:connection-point |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:connection-point[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/connection-point/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:connection-point |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:connection-point[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ConnectionPoint |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ConnectionPoint |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ConnectionPoint |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ConnectionPoint |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ConnectionPoint |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the NS connection point. |
| type | ENUM | Type of the connection point. |
nsd:scaling-group-descriptor
scaling group descriptor within this network service. The scaling group defines a group of VNFs, and the ratio of VNFs in the network service that is used as target for scaling action
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ScalingGroupDescriptor |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ScalingGroupDescriptor |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ScalingGroupDescriptor |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ScalingGroupDescriptor |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ScalingGroupDescriptor |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of this scaling group. |
| scaling-policy | LIST | |
| vnfd-member | LIST | List of VNFs in this scaling group |
| min-instance-count | UINT32 | Minimum instances of the scaling group which are allowed. These instances are created by default when the network service is instantiated. |
| max-instance-count | UINT32 | Maximum instances of this scaling group that are allowed in a single network service. The network service scaling will fail, when the number of service group instances exceed the max-instance-count specified. |
| scaling-config-action | LIST | List of scaling config actions |
nsd:scaling-policy
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:scaling-policy |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:scaling-policy[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-policy/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:scaling-policy |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:scaling-policy[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ScalingGroupDescriptor.ScalingPolicy |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ScalingGroupDescriptor__ScalingPolicy |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the scaling policy |
| scaling-type | ENUM | Type of scaling |
| enabled | BOOLEAN | Specifies if the scaling policy can be applied |
| scale-in-operation-type | ENUM | Operation to be applied to check between scaling criterias to check if the scale in threshold condition has been met. Defaults to AND |
| scale-out-operation-type | ENUM | Operation to be applied to check between scaling criterias to check if the scale out threshold condition has been met. Defauls to OR |
| threshold-time | UINT32 | The duration for which the criteria must hold true |
| cooldown-time | UINT32 | The duration after a scaling-in/scaling-out action has been triggered, for which there will be no further optional |
| scaling-criteria | LIST | list of conditions to be met for generating scaling requests |
nsd:scaling-criteria
list of conditions to be met for generating scaling requests
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:scaling-policy/nsd:scaling-criteria |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:scaling-policy[nsd:name='STRING']/nsd:scaling-criteria[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-policy/STRING/scaling-criteria/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:scaling-policy/nsd:scaling-criteria |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:scaling-policy[nsd:name='STRING']/nsd:scaling-criteria[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ScalingGroupDescriptor.ScalingPolicy.ScalingCriteria |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy_ScalingCriteria |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ScalingGroupDescriptor__ScalingPolicy__ScalingCriteria |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy_ScalingCriteria |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy_ScalingCriteria |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| scale-in-threshold | UINT64 | Value below which scale-in requests are generated |
| scale-out-threshold | UINT64 | Value above which scale-out requests are generated |
| ns-monitoring-param-ref | LEAFREF | Reference to the NS level monitoring parameter that is aggregated |
nsd:vnfd-member
List of VNFs in this scaling group
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:vnfd-member |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:vnfd-member[nsd:member-vnf-index-ref='0'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/vnfd-member/0 |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:vnfd-member |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:vnfd-member[nsd:member-vnf-index-ref='0'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ScalingGroupDescriptor.VnfdMember |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ScalingGroupDescriptor_VnfdMember |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ScalingGroupDescriptor__VnfdMember |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ScalingGroupDescriptor_VnfdMember |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ScalingGroupDescriptor_VnfdMember |
Fields
| Name | Type | Description |
|---|---|---|
| member-vnf-index-ref | LEAFREF | member VNF index of this member VNF |
| count | UINT32 | count of this member VNF within this scaling group. The count allows to define the number of instances when a scaling action targets this scaling group |
nsd:scaling-config-action
List of scaling config actions
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:scaling-config-action |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:scaling-config-action[nsd:trigger='pre-scale-in'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-config-action/pre-scale-in |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:scaling-config-action |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:scaling-config-action[nsd:trigger='pre-scale-in'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ScalingGroupDescriptor.ScalingConfigAction |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingConfigAction |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ScalingGroupDescriptor__ScalingConfigAction |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingConfigAction |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingConfigAction |
Fields
| Name | Type | Description |
|---|---|---|
| trigger | ENUM | scaling trigger |
| ns-service-primitive-name-ref | LEAFREF | Reference to the NS service primitive |
nsd:vnffgd
List of VNF Forwarding Graph Descriptors (VNFFGD).
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vnffgd |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vnffgd/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vnffgd |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.Vnffgd |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_Vnffgd |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__Vnffgd |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_Vnffgd |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_Vnffgd |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the VNFFGD. |
| name | STRING | VNFFGD name. |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Provider of the VNFFGD. |
| description | STRING | Description of the VNFFGD. |
| version | STRING | Version of the VNFFGD |
| rsp | LIST | List of Rendered Service Paths (RSP). |
| classifier | LIST | List of classifier rules. |
nsd:rsp
List of Rendered Service Paths (RSP).
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:rsp |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:rsp[nsd:id='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/rsp/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:rsp |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:rsp[nsd:id='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.Vnffgd.Rsp |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_Vnffgd_Rsp |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__Vnffgd__Rsp |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_Vnffgd_Rsp |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_Vnffgd_Rsp |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the RSP. |
| name | STRING | RSP name. |
| vnfd-connection-point-ref | LIST | A list of references to connection points. |
nsd:vnfd-connection-point-ref
A list of references to connection points.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:rsp/nsd:vnfd-connection-point-ref |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:rsp[nsd:id='STRING']/nsd:vnfd-connection-point-ref[nsd:member-vnf-index-ref='0'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/rsp/STRING/vnfd-connection-point-ref/0 |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:rsp/nsd:vnfd-connection-point-ref |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:rsp[nsd:id='STRING']/nsd:vnfd-connection-point-ref[nsd:member-vnf-index-ref='0'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.Vnffgd.Rsp.VnfdConnectionPointRef |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_Vnffgd_Rsp_VnfdConnectionPointRef |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__Vnffgd__Rsp__VnfdConnectionPointRef |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_Vnffgd_Rsp_VnfdConnectionPointRef |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_Vnffgd_Rsp_VnfdConnectionPointRef |
Fields
| Name | Type | Description |
|---|---|---|
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| order | UINT8 | A number that denotes the order of a VNF in a chain |
| vnfd-id-ref | LEAFREF | A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref |
| vnfd-connection-point-ref | STRING | A reference to a connection point name in a vnfd. This is a leafref to path: /vnfd:vnfd-catalog/vnfd:vnfd + [vnfd:id = current()/../nsd:vnfd-id-ref] + /vnfd:connection-point/vnfd:name NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref |
nsd:classifier
List of classifier rules.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:classifier |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:classifier[nsd:id='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/classifier/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:classifier |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:classifier[nsd:id='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.Vnffgd.Classifier |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_Vnffgd_Classifier |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__Vnffgd__Classifier |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_Vnffgd_Classifier |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_Vnffgd_Classifier |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the classifier rule. |
| name | STRING | Name of the classifier. |
| rsp-id-ref | LEAFREF | A reference to the RSP. |
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| vnfd-id-ref | LEAFREF | A reference to a vnfd. This is a leafref to path: ../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref |
| vnfd-connection-point-ref | STRING | A reference to a connection point name in a vnfd. This is a leafref to path: /vnfd:vnfd-catalog/vnfd:vnfd + [vnfd:id = current()/../nsd:vnfd-id-ref] + /vnfd:connection-point/vnfd:name NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref |
| match-attributes | LIST | List of match attributes. |
nsd:match-attributes
List of match attributes.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:classifier/nsd:match-attributes |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:classifier[nsd:id='STRING']/nsd:match-attributes[nsd:id='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/classifier/STRING/match-attributes/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:classifier/nsd:match-attributes |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:classifier[nsd:id='STRING']/nsd:match-attributes[nsd:id='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.Vnffgd.Classifier.MatchAttributes |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_Vnffgd_Classifier_MatchAttributes |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__Vnffgd__Classifier__MatchAttributes |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_Vnffgd_Classifier_MatchAttributes |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_Vnffgd_Classifier_MatchAttributes |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the classifier match attribute rule. |
| ip-proto | UINT8 | IP Protocol. |
| source-ip-address | UNION | Source IP address. |
| destination-ip-address | UNION | Destination IP address. |
| source-port | UINT16 | Source port number. |
| destination-port | UINT16 | Destination port number. |
nsd:ip-profiles
List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.IpProfiles |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_IpProfiles |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__IpProfiles |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_IpProfiles |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_IpProfiles |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the IP-Profile |
| description | STRING | Description for IP profile |
| ip-profile-params | CONTAINER |
nsd:ip-profile-params
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles/nsd:ip-profile-params |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING']/nsd:ip-profile-params |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING/ip-profile-params |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles/nsd:ip-profile-params |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING']/nsd:ip-profile-params |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.IpProfiles.IpProfileParams |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_IpProfiles_IpProfileParams |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__IpProfiles__IpProfileParams |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_IpProfiles_IpProfileParams |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_IpProfiles_IpProfileParams |
Fields
| Name | Type | Description |
|---|---|---|
| ip-version | ENUM | |
| subnet-address | UNION | Subnet IP prefix associated with IP Profile |
| gateway-address | UNION | IP Address of the default gateway associated with IP Profile |
| security-group | STRING | Name of the security group |
| dns-server | LIST | |
| dhcp-params | CONTAINER | |
| subnet-prefix-pool | STRING | VIM Specific reference to pre-created subnet prefix |
nsd:dns-server
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles/nsd:ip-profile-params/nsd:dns-server |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING']/nsd:ip-profile-params/nsd:dns-server[nsd:address='UNION_VALUE'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING/ip-profile-params/dns-server/UNION_VALUE |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles/nsd:ip-profile-params/nsd:dns-server |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING']/nsd:ip-profile-params/nsd:dns-server[nsd:address='UNION_VALUE'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.IpProfiles.IpProfileParams.DnsServer |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DnsServer |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__IpProfiles__IpProfileParams__DnsServer |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DnsServer |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DnsServer |
Fields
| Name | Type | Description |
|---|---|---|
| address | UNION | List of DNS Servers associated with IP Profile |
nsd:dhcp-params
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles/nsd:ip-profile-params/nsd:dhcp-params |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING']/nsd:ip-profile-params/nsd:dhcp-params |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING/ip-profile-params/dhcp-params |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles/nsd:ip-profile-params/nsd:dhcp-params |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING']/nsd:ip-profile-params/nsd:dhcp-params |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.IpProfiles.IpProfileParams.DhcpParams |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DhcpParams |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__IpProfiles__IpProfileParams__DhcpParams |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DhcpParams |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DhcpParams |
Fields
| Name | Type | Description |
|---|---|---|
| enabled | BOOLEAN | This flag indicates if DHCP is enabled or not |
| start-address | UNION | Start IP address of the IP-Address range associated with DHCP domain |
| count | UINT32 | Size of the DHCP pool associated with DHCP domain |
nsd:initial-service-primitive
Initial set of service primitives for NSD.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:initial-service-primitive |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:initial-service-primitive[nsd:seq='0'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/initial-service-primitive/0 |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:initial-service-primitive |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:initial-service-primitive[nsd:seq='0'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.InitialServicePrimitive |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_InitialServicePrimitive |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__InitialServicePrimitive |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_InitialServicePrimitive |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_InitialServicePrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| seq | UINT64 | Sequence number for the configuration primitive. |
| name | STRING | Name of the configuration primitive. |
| user-defined-script | STRING | A user defined script. |
| parameter | LIST |
nsd:parameter
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:initial-service-primitive/nsd:parameter |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:initial-service-primitive[nsd:seq='0']/nsd:parameter[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/initial-service-primitive/0/parameter/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:initial-service-primitive/nsd:parameter |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:initial-service-primitive[nsd:seq='0']/nsd:parameter[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.InitialServicePrimitive.Parameter |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_InitialServicePrimitive_Parameter |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__InitialServicePrimitive__Parameter |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_InitialServicePrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_InitialServicePrimitive_Parameter |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| value | STRING | Value of the configuration primitive. |
nsd:terminate-service-primitive
Set of service primitives during termination for NSD.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:terminate-service-primitive |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:terminate-service-primitive[nsd:seq='0'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/terminate-service-primitive/0 |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:terminate-service-primitive |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:terminate-service-primitive[nsd:seq='0'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.TerminateServicePrimitive |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_TerminateServicePrimitive |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__TerminateServicePrimitive |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_TerminateServicePrimitive |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_TerminateServicePrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| seq | UINT64 | Sequence number for the configuration primitive. |
| name | STRING | Name of the configuration primitive. |
| user-defined-script | STRING | A user defined script. |
| parameter | LIST |
nsd:parameter
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:terminate-service-primitive/nsd:parameter |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:terminate-service-primitive[nsd:seq='0']/nsd:parameter[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/terminate-service-primitive/0/parameter/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:terminate-service-primitive/nsd:parameter |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:terminate-service-primitive[nsd:seq='0']/nsd:parameter[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.TerminateServicePrimitive.Parameter |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_TerminateServicePrimitive_Parameter |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__TerminateServicePrimitive__Parameter |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_TerminateServicePrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_TerminateServicePrimitive_Parameter |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| value | STRING | Value of the configuration primitive. |
nsd:input-parameter-xpath
List of xpaths to parameters inside the NSD the can be customized during the instantiation.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:input-parameter-xpath |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:input-parameter-xpath[nsd:xpath='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/input-parameter-xpath/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:input-parameter-xpath |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:input-parameter-xpath[nsd:xpath='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.InputParameterXpath |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_InputParameterXpath |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__InputParameterXpath |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_InputParameterXpath |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_InputParameterXpath |
Fields
| Name | Type | Description |
|---|---|---|
| xpath | STRING | An xpath that specifies the element in a descriptor. |
| label | STRING | A descriptive string |
| default-value | STRING | Default Value for the Input Parameter |
nsd:parameter-pool
Pool of parameter values which must be pulled from during configuration
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:parameter-pool |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:parameter-pool[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/parameter-pool/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:parameter-pool |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:parameter-pool[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ParameterPool |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ParameterPool |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ParameterPool |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ParameterPool |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ParameterPool |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the configuration value pool |
| range | CONTAINER | Create a range of values to populate the pool with |
nsd:range
Create a range of values to populate the pool with
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:parameter-pool/nsd:range |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:parameter-pool[nsd:name='STRING']/nsd:range |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/parameter-pool/STRING/range |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:parameter-pool/nsd:range |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:parameter-pool[nsd:name='STRING']/nsd:range |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ParameterPool.Range |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ParameterPool_Range |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ParameterPool__Range |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ParameterPool_Range |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ParameterPool_Range |
Fields
| Name | Type | Description |
|---|---|---|
| start-value | UINT32 | Generated pool values start at this value |
| end-value | UINT32 | Generated pool values stop at this value |
nsd:key-pair
Used to configure the list of public keys to be injected as part of ns instantiation
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:key-pair |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:key-pair[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/key-pair/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:key-pair |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:key-pair[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.KeyPair |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_KeyPair |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__KeyPair |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_KeyPair |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_KeyPair |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of this key pair |
| key | STRING | Key associated with this key pair |
nsd:user
List of users to be added through cloud-config
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:user |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:user[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/user/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:user |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:user[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.User |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_User |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__User |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_User |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_User |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the user |
| user-info | STRING | The user name's real name |
| key-pair | LIST | Used to configure the list of public keys to be injected as part of ns instantiation |
nsd:key-pair
Used to configure the list of public keys to be injected as part of ns instantiation
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:user/nsd:key-pair |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:user[nsd:name='STRING']/nsd:key-pair[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/user/STRING/key-pair/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:user/nsd:key-pair |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:user[nsd:name='STRING']/nsd:key-pair[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.User.KeyPair |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_User_KeyPair |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__User__KeyPair |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_User_KeyPair |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_User_KeyPair |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of this key pair |
| key | STRING | Key associated with this key pair |
nsd:vld
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vld |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vld/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vld |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING'] |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.Vld |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_Vld |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__Vld |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_Vld |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_Vld |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the VLD. |
| name | STRING | Virtual Link Descriptor (VLD) name. |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Provider of the VLD. |
| description | STRING | Description of the VLD. |
| version | STRING | Version of the VLD |
| type | ENUM | |
| root-bandwidth | UINT64 | For ELAN this is the aggregate bandwidth. |
| leaf-bandwidth | UINT64 | For ELAN this is the bandwidth of branches. |
| provider-network | CONTAINER | Container for the provider network. |
| mgmt-network | BOOLEAN | Flag indicating whether this network is a VIM management network |
| vim-network-name | STRING | Name of network in VIM account. This is used to indicate pre-provisioned network name in cloud account. |
| ip-profile-ref | LEAFREF | Named reference to IP-profile object |
| vnfd-connection-point-ref | LIST | A list of references to connection points. |
| ipv4-nat-pool-name | STRING | IPV4 nat pool name |
| virtual-connection-points | LIST | A list of virtual-connection points associated with Virtual Link. These connection points are not directly associated with any VNFs |
nsd:provider-network
Container for the provider network.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vld/nsd:provider-network |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']/nsd:provider-network |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vld/STRING/provider-network |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vld/nsd:provider-network |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']/nsd:provider-network |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.Vld.ProviderNetwork |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_Vld_ProviderNetwork |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__Vld__ProviderNetwork |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_Vld_ProviderNetwork |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_Vld_ProviderNetwork |
Fields
| Name | Type | Description |
|---|---|---|
| physical-network | STRING | Name of the physical network on which the provider network is built. |
| segmentation_id | UINT32 | ID of segregated virtual networks |
nsd:vnfd-connection-point-ref
A list of references to connection points.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vld/nsd:vnfd-connection-point-ref |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']/nsd:vnfd-connection-point-ref[nsd:member-vnf-index-ref='0'][nsd:vnfd-connection-point-ref='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vld/STRING/vnfd-connection-point-ref/0,STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vld/nsd:vnfd-connection-point-ref |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']/nsd:vnfd-connection-point-ref[nsd:member-vnf-index-ref='0'][nsd:vnfd-connection-point-ref='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.Vld.VnfdConnectionPointRef |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_Vld_VnfdConnectionPointRef |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__Vld__VnfdConnectionPointRef |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_Vld_VnfdConnectionPointRef |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_Vld_VnfdConnectionPointRef |
Fields
| Name | Type | Description |
|---|---|---|
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| vnfd-id-ref | LEAFREF | A reference to a VNFD |
| vnfd-connection-point-ref | LEAFREF | A reference to a connection point name |
rw-nsd:virtual-connection-points
A list of virtual-connection points associated with Virtual Link. These connection points are not directly associated with any VNFs
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vld/rw-nsd:virtual-connection-points |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']/rw-nsd:virtual-connection-points[rw-nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vld/STRING/rw-nsd:virtual-connection-points/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vld/rw-nsd:virtual-connection-points |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']/rw-nsd:virtual-connection-points[rw-nsd:name='STRING'] |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.Vld.VirtualConnectionPoints |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_Vld_VirtualConnectionPoints |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__Vld__VirtualConnectionPoints |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_Vld_VirtualConnectionPoints |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_Vld_VirtualConnectionPoints |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the connection point |
| id | STRING | Identifier for the internal connection points |
| short-name | STRING | Short name to appear as label in the UI |
| type | ENUM | Type of the connection point. |
| port-security-enabled | BOOLEAN | Enables the port security for the port |
| associated-cps | LEAF_LIST | A List of connection points associated with virtual connection point |
rw-nsd:associated-cps
A List of connection points associated with virtual connection point
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vld/rw-nsd:virtual-connection-points/rw-nsd:associated-cps |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']/rw-nsd:virtual-connection-points[rw-nsd:name='STRING']/rw-nsd:associated-cps |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vld/STRING/rw-nsd:virtual-connection-points/STRING/associated-cps |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vld/rw-nsd:virtual-connection-points/rw-nsd:associated-cps |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']/rw-nsd:virtual-connection-points[rw-nsd:name='STRING']/rw-nsd:associated-cps |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.Vld.VirtualConnectionPoints.AssociatedCps |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_Vld_VirtualConnectionPoints_AssociatedCps |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__Vld__VirtualConnectionPoints__AssociatedCps |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_Vld_VirtualConnectionPoints_AssociatedCps |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_Vld_VirtualConnectionPoints_AssociatedCps |
nsd:constituent-vnfd
List of VNFDs that are part of this network service.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:constituent-vnfd |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:constituent-vnfd[nsd:member-vnf-index='0'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/constituent-vnfd/0 |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:constituent-vnfd |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:constituent-vnfd[nsd:member-vnf-index='0'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ConstituentVnfd |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ConstituentVnfd |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ConstituentVnfd |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ConstituentVnfd |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ConstituentVnfd |
Fields
| Name | Type | Description |
|---|---|---|
| member-vnf-index | UINT64 | Identifier/index for the VNFD. This separate id is required to ensure that multiple VNFs can be part of single NS |
| vnfd-id-ref | LEAFREF | Identifier for the VNFD. |
| start-by-default | BOOLEAN | VNFD is started as part of the NS instantiation |
nsd:placement-groups
List of placement groups at NS level
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:placement-groups |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:placement-groups[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/placement-groups/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:placement-groups |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:placement-groups[nsd:name='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.PlacementGroups |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_PlacementGroups |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__PlacementGroups |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_PlacementGroups |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_PlacementGroups |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Place group construct to define the compute resource placement strategy in cloud environment |
| requirement | STRING | This is free text space used to describe the intent/rationale behind this placement group. This is for human consumption only |
| strategy | ENUM | Strategy associated with this placement group Following values are possible - COLOCATION: Colocation strategy imply intent to share the physical infrastructure (hypervisor/network) among all members of this group. - ISOLATION: Isolation strategy imply intent to not share the physical infrastructure (hypervisor/network) among the members of this group. |
| member-vnfd | LIST | List of VNFDs that are part of this placement group |
nsd:member-vnfd
List of VNFDs that are part of this placement group
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:placement-groups/nsd:member-vnfd |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:placement-groups[nsd:name='STRING']/nsd:member-vnfd[nsd:member-vnf-index-ref='0'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/placement-groups/STRING/member-vnfd/0 |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:placement-groups/nsd:member-vnfd |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:placement-groups[nsd:name='STRING']/nsd:member-vnfd[nsd:member-vnf-index-ref='0'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.PlacementGroups.MemberVnfd |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_PlacementGroups_MemberVnfd |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__PlacementGroups__MemberVnfd |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_PlacementGroups_MemberVnfd |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_PlacementGroups_MemberVnfd |
Fields
| Name | Type | Description |
|---|---|---|
| member-vnf-index-ref | LEAFREF | Member VNF index of this member VNF |
| vnfd-id-ref | LEAFREF | Identifier for the VNFD. |
nsd:vnf-dependency
List of VNF dependencies.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:vnf-dependency |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnf-dependency[nsd:vnf-source-ref='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/vnf-dependency/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:vnf-dependency |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnf-dependency[nsd:vnf-source-ref='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.VnfDependency |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_VnfDependency |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__VnfDependency |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_VnfDependency |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_VnfDependency |
Fields
| Name | Type | Description |
|---|---|---|
| vnf-source-ref | LEAFREF | |
| vnf-depends-on-ref | LEAFREF | Reference to VNF that sorce VNF depends. |
nsd:monitoring-param
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.MonitoringParam |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_MonitoringParam |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__MonitoringParam |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_MonitoringParam |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_MonitoringParam |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | |
| name | STRING | |
| value-type | ENUM | |
| numeric-constraints | CONTAINER | |
| text-constraints | CONTAINER | |
| value-integer | INT64 | Current value for an integer parameter |
| value-decimal | DECIMAL64 | Current value for a decimal parameter |
| value-string | STRING | Current value for a string parameter |
| description | STRING | |
| group-tag | STRING | A tag to group monitoring parameters |
| widget-type | ENUM | Defines the UI Display variant of measured counters. |
| units | STRING | Measured Counter Units (e.g., Packets, Kbps, Mbps, etc.) |
| aggregation-type | ENUM | |
| vnfd-monitoring-param | LIST | A list of VNFD monitoring params |
nsd:numeric-constraints
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param/nsd:numeric-constraints |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING']/nsd:numeric-constraints |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING/numeric-constraints |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param/nsd:numeric-constraints |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING']/nsd:numeric-constraints |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.MonitoringParam.NumericConstraints |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_MonitoringParam_NumericConstraints |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__MonitoringParam__NumericConstraints |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_MonitoringParam_NumericConstraints |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_MonitoringParam_NumericConstraints |
Fields
| Name | Type | Description |
|---|---|---|
| min-value | UINT64 | Minimum value for the parameter |
| max-value | UINT64 | Maximum value for the parameter |
nsd:text-constraints
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param/nsd:text-constraints |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING']/nsd:text-constraints |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING/text-constraints |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param/nsd:text-constraints |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING']/nsd:text-constraints |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.MonitoringParam.TextConstraints |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_MonitoringParam_TextConstraints |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__MonitoringParam__TextConstraints |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_MonitoringParam_TextConstraints |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_MonitoringParam_TextConstraints |
Fields
| Name | Type | Description |
|---|---|---|
| min-length | UINT8 | Minimum string length for the parameter |
| max-length | UINT8 | Maximum string length for the parameter |
nsd:vnfd-monitoring-param
A list of VNFD monitoring params
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param/nsd:vnfd-monitoring-param |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING']/nsd:vnfd-monitoring-param[nsd:member-vnf-index-ref='0'][nsd:vnfd-monitoring-param-ref='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING/vnfd-monitoring-param/0,STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param/nsd:vnfd-monitoring-param |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING']/nsd:vnfd-monitoring-param[nsd:member-vnf-index-ref='0'][nsd:vnfd-monitoring-param-ref='STRING'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.MonitoringParam.VnfdMonitoringParam |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_MonitoringParam_VnfdMonitoringParam |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__MonitoringParam__VnfdMonitoringParam |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_MonitoringParam_VnfdMonitoringParam |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_MonitoringParam_VnfdMonitoringParam |
Fields
| Name | Type | Description |
|---|---|---|
| vnfd-id-ref | LEAFREF | A reference to a VNFD. This is a leafref |
| vnfd-monitoring-param-ref | LEAFREF | A reference to the VNFD monitoring param |
| member-vnf-index-ref | LEAFREF | Mandatory reference to member-vnf within constituent-vnfds |
nsd:service-primitive
Network service level service primitives.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:service-primitive |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/service-primitive/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING'] |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.ServicePrimitive |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_ServicePrimitive |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__ServicePrimitive |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the service primitive. |
| parameter | LIST | List of parameters for the service primitive. |
| parameter-group | LIST | Grouping of parameters which are logically grouped in UI |
| vnf-primitive-group | LIST | List of service primitives grouped by VNF. |
| user-defined-script | STRING | A user defined script. |
nsd:parameter
List of parameters for the service primitive.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:parameter |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:parameter[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:parameter |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:parameter[nsd:name='STRING'] |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.ServicePrimitive.Parameter |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_ServicePrimitive_Parameter |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__ServicePrimitive__Parameter |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive_Parameter |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter. |
| data-type | ENUM | Data type associated with the name. |
| mandatory | BOOLEAN | Is this field mandatory |
| default-value | STRING | The default value for this field |
| parameter-pool | STRING | NSD parameter pool name to use for this parameter |
| read-only | BOOLEAN | The value should be dimmed by the UI. Only applies to parameters with default values. |
| hidden | BOOLEAN | The value should be hidden by the UI. Only applies to parameters with default values. |
| out | BOOLEAN | If this is an output of the primitive execution |
nsd:parameter-group
Grouping of parameters which are logically grouped in UI
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:parameter-group |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:parameter-group[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter-group/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:parameter-group |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:parameter-group[nsd:name='STRING'] |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.ServicePrimitive.ParameterGroup |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__ServicePrimitive__ParameterGroup |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter group |
| parameter | LIST | List of parameters for the service primitive. |
| mandatory | BOOLEAN | Is this parameter group mandatory |
nsd:parameter
List of parameters for the service primitive.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:parameter-group/nsd:parameter |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:parameter-group[nsd:name='STRING']/nsd:parameter[nsd:name='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter-group/STRING/parameter/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:parameter-group/nsd:parameter |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:parameter-group[nsd:name='STRING']/nsd:parameter[nsd:name='STRING'] |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.ServicePrimitive.ParameterGroup.Parameter |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup_Parameter |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__ServicePrimitive__ParameterGroup__Parameter |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup_Parameter |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup_Parameter |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter. |
| data-type | ENUM | Data type associated with the name. |
| mandatory | BOOLEAN | Is this field mandatory |
| default-value | STRING | The default value for this field |
| parameter-pool | STRING | NSD parameter pool name to use for this parameter |
| read-only | BOOLEAN | The value should be dimmed by the UI. Only applies to parameters with default values. |
| hidden | BOOLEAN | The value should be hidden by the UI. Only applies to parameters with default values. |
| out | BOOLEAN | If this is an output of the primitive execution |
nsd:vnf-primitive-group
List of service primitives grouped by VNF.
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:vnf-primitive-group |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:vnf-primitive-group[nsd:member-vnf-index-ref='0'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/vnf-primitive-group/0 |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:vnf-primitive-group |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:vnf-primitive-group[nsd:member-vnf-index-ref='0'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ServicePrimitive.VnfPrimitiveGroup |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ServicePrimitive__VnfPrimitiveGroup |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup |
Fields
| Name | Type | Description |
|---|---|---|
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| vnfd-id-ref | LEAFREF | A reference to a VNFD. This is a leafref |
| vnfd-name | LEAFREF | Name of the VNFD |
| primitive | LIST |
nsd:primitive
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:vnf-primitive-group/nsd:primitive |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:vnf-primitive-group[nsd:member-vnf-index-ref='0']/nsd:primitive[nsd:index='0'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/vnf-primitive-group/0/primitive/0 |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:vnf-primitive-group/nsd:primitive |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:vnf-primitive-group[nsd:member-vnf-index-ref='0']/nsd:primitive[nsd:index='0'] |
| Protobuf Type | .nsd.YangData.Nsd.NsdCatalog.Nsd.ServicePrimitive.VnfPrimitiveGroup.Primitive |
| Python Proto-GI Type | NsdYang.YangData_Nsd_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup_Primitive |
| C Protobuf-C Struct Type | Nsd__YangData__Nsd__NsdCatalog__Nsd__ServicePrimitive__VnfPrimitiveGroup__Primitive |
| C RWPB Identifiers | Nsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup_Primitive |
| YPBC Base Identifier | rw_ypbc_Nsd_Nsd_data_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup_Primitive |
Fields
| Name | Type | Description |
|---|---|---|
| index | UINT32 | Index of this primitive |
| name | STRING | Name of the primitive in the VNF primitive |
rw-nsd:control-param
List of control parameters to manage and update the running configuration of the VNF
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/rw-nsd:control-param |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/rw-nsd:control-param[rw-nsd:id='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/rw-nsd:control-param/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/rw-nsd:control-param |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/rw-nsd:control-param[rw-nsd:id='STRING'] |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.ControlParam |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_ControlParam |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__ControlParam |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_ControlParam |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_ControlParam |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for control parameter |
| name | STRING | Name of a control parameter |
| description | STRING | A description of the control parameter |
| group-tag | STRING | A tag to group control parameters |
| min-value | UINT64 | Minimum value for the parameter |
| max-value | UINT64 | Maximum value for the parameter |
| current-value | UINT64 | Current value for the parameter |
| step-value | UINT64 | Step value for the parameter |
| units | STRING | |
| widget-type | ENUM | |
| url | STRING | This is the URL where the operation should be performed. |
| method | ENUM | Method that the URI should perform. Default Action is POST |
| payload | STRING | This is the operation payload or payload template as stringified JSON. This field provides the data to be sent for this operation call |
rw-nsd:action-param
List of action parameters to control VNF
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/rw-nsd:action-param |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/rw-nsd:action-param[rw-nsd:id='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/rw-nsd:action-param/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/rw-nsd:action-param |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/rw-nsd:action-param[rw-nsd:id='STRING'] |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.ActionParam |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_ActionParam |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__ActionParam |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_ActionParam |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_ActionParam |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | |
| name | STRING | |
| description | STRING | |
| group-tag | STRING | A tag to group monitoring parameter |
| url | STRING | This is the URL where to perform the operation |
| method | ENUM | This is the method to be performed at the uri. POST by default for action |
| payload | STRING | This is the operation payload or payload template to be sent in the data for this operation call |
rw-nsd:config-parameter-map
A mapping of VNF config parameter requests and sources within this network service
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/rw-nsd:config-parameter-map |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/rw-nsd:config-parameter-map[rw-nsd:id='STRING'] |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/rw-nsd:config-parameter-map/STRING |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/rw-nsd:config-parameter-map |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/rw-nsd:config-parameter-map[rw-nsd:id='STRING'] |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.ConfigParameterMap |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_ConfigParameterMap |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__ConfigParameterMap |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_ConfigParameterMap |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_ConfigParameterMap |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identfier for VNF map |
| config-parameter-request | CONTAINER | |
| config-parameter-source | CONTAINER |
rw-nsd:config-parameter-request
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/rw-nsd:config-parameter-map/rw-nsd:config-parameter-request |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/rw-nsd:config-parameter-map[rw-nsd:id='STRING']/rw-nsd:config-parameter-request |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/rw-nsd:config-parameter-map/STRING/config-parameter-request |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/rw-nsd:config-parameter-map/rw-nsd:config-parameter-request |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/rw-nsd:config-parameter-map[rw-nsd:id='STRING']/rw-nsd:config-parameter-request |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.ConfigParameterMap.ConfigParameterRequest |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterRequest |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__ConfigParameterMap__ConfigParameterRequest |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterRequest |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterRequest |
Fields
| Name | Type | Description |
|---|---|---|
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| vnfd-id-ref | LEAFREF | A reference to a vnfd. |
| config-parameter-request-ref | LEAFREF | Reference to the request in the VNF with the specified member-vnf-index |
rw-nsd:config-parameter-source
Key Identifiers:| XPath Path | /nsd:nsd-catalog/nsd:nsd/rw-nsd:config-parameter-map/rw-nsd:config-parameter-source |
| XPath Keyed Path | /nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/rw-nsd:config-parameter-map[rw-nsd:id='STRING']/rw-nsd:config-parameter-source |
| RW.REST URI Path | /nsd:nsd-catalog/nsd/STRING/rw-nsd:config-parameter-map/STRING/config-parameter-source |
| RW Keyspec XPath Path | C,/nsd:nsd-catalog/nsd:nsd/rw-nsd:config-parameter-map/rw-nsd:config-parameter-source |
| RW Keyspec XPath Keyed Path | C,/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/rw-nsd:config-parameter-map[rw-nsd:id='STRING']/rw-nsd:config-parameter-source |
| Protobuf Type | .rw_nsd.YangData.Nsd.NsdCatalog.Nsd.ConfigParameterMap.ConfigParameterSource |
| Python Proto-GI Type | RwNsdYang.YangData_Nsd_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterSource |
| C Protobuf-C Struct Type | RwNsd__YangData__Nsd__NsdCatalog__Nsd__ConfigParameterMap__ConfigParameterSource |
| C RWPB Identifiers | RwNsd_Nsd_data_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterSource |
| YPBC Base Identifier | rw_ypbc_RwNsd_Nsd_data_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterSource |
Fields
| Name | Type | Description |
|---|---|---|
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| vnfd-id-ref | LEAFREF | A reference to a vnfd. |
| config-parameter-source-ref | LEAFREF | Reference to the source in the VNF with the specified member-vnf-index |
rw-nsd - Programmers API Reference
Schema Globals
| Global Schema Type | rw_ypbc_RwNsd_RwNsd_t_schema |
| Global Schema Pointer | rw_ypbc_RwNsd_RwNsd_g_schema |