4.3.2. Data Types

1.1.1.2        SDC Data Type Definitions



Tosca Type

Conformance level

Status

org.openecomp.datatypes.ONAPHoming

2.0

Defined

org.openecomp.datatypes.ONAPNaming

2.0

Defined

org.openecomp.datatypes.network.SubnetAssignments

2.0

Defined

org.openecomp.datatypes.network.IPv4SubnetAssignments

2.0

Defined

org.openecomp.datatypes.network.IPv6SubnetAssignments

2.0

Defined

org.openecomp.datatypes.network.NetworkAssignments

9.0

2.0 Defined

9.0 Updated

org.openecomp.datatypes.network.NetworkFlows

2.0

Defined

org.openecomp.datatypes.network.ProviderNetwork

2.0

Defined

org.openecomp.datatypes.Naming

3.0

Defined

org.openecomp.datatypes.network.MacAssignments

3.0

Defined

org.openecomp.datatypes.network.VlanRequirements

3.0

Defined

org.openecomp.datatypes.network.IpRequirements

4.0

3.0 Defined

4.0 Updated

org.openecomp.datatypes.AssignmentRequirements

4.0

Defined

org.openecomp.datatypes.flavors.DeploymentFlavor

4.0

Defined

org.openecomp.datatypes.flavors.ComputeFlavor

4.0

Defined

org.openecomp.datatypes.flavors.LicenseFlavor

4.0

Defined

org.openecomp.datatypes.flavors.VendorInfo

4.0

Defined

org.openecomp.datatypes.ImageInfo

4.0

Defined

org.openecomp.datatypes.PortMirroringConnectionPointDescription

8.0

5.0 Defined

8.0 Updated

org.openecomp.datatypes.RelatedNetworksAssignments

9.0

9.0 Defined



1.1.1.2.1      org.openecomp.datatypes.ONAPHoming



org.openecomp.datatypes.ONAPHoming:

    derived_from: org.openecomp.datatypes.Root

    properties:



ONAP_selected_instance_node_target:



type: boolean

required: true

default: false

description: |

\"true\" indicates that the target deployment node for this instance will be auto-selected by ONAP

\"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the operator-selected target node for the deployment of this Network instance). 



homing_policy:



type: string

required: false

description: Reference to a service level homing policy that ONAP will use for instance deployment target node



instance_node_target:

type: string

required: false

description: Instance target deployment node









1.1.1.2.2      org.openecomp.datatypes.ONAPNaming



org.openecomp.datatypes.ONAPNaming:

     derived_from: org.openecomp.datatypes.Root

      properties:



ONAP_generated_naming:



type: boolean

required: true

default: true

description: |

\"true\" indicates that the name for the instance will be auto-generated by ONAP. \"false\" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).



naming_policy:

type: string

required: false

 description: Reference to naming policy that ONAP will use when the name is auto-generated









1.1.1.2.3      org.openecomp.datatypes.network.SubnetAssignments



org.openecomp.datatypes.network.SubnetAssignments:

   derived_from: org.openecomp.datatypes.Root

    properties:



ip_network_address_plan:



type: string

required: false

description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network



dhcp_enabled:



type: boolean

required: false

description: \"true\" indicates the network has 1 or more policies



ip_version:



type: integer

constraints:

- valid_values:

     - 4

     - 6

required: true

description: The IP version of the subnet



cidr_mask:

type: integer

required: true

description: The default subnet CIDR mask



min_subnets_count:

type: integer

default: 1

required: true

description: Quantity of subnets that must be initially assigned









1.1.1.2.4      org.openecomp.datatypes.network.IPv4SubnetAssignments



org.openecomp.datatypes.network.IPv4SubnetAssignments:

   derived_from: org.openecomp.datatypes.network.SubnetAssignments

    properties:



use_ipv4:



type: boolean

required: true

description: Indicates IPv4 subnet assignments









1.1.1.2.5      org.openecomp.datatypes.network.IPv6SubnetAssignments



org.openecomp.datatypes.network.IPv6SubnetAssignments:

   derived_from: org.openecomp.datatypes.network.SubnetAssignments

    properties:



use_ipv6:



type: boolean

required: true

description: Indicates IPv6 subnet assignments









1.1.1.2.6      org.openecomp.datatypes.network.NetworkAssignments



org.openecomp.datatypes.network.NetworkAssignments:

    derived_from: org.openecomp.datatypes.Root

    properties:

ONAP_generated_network_assignment:



type: boolean

required: true

default: false

description: |

\"true\" indicates that the network assignments will be auto-generated by ONAP \"false\" indicates operator-supplied Network assignments file upload is required (e.g. VID will present prompt to operator to upload operator-supplied Network assignments file).

is_shared_network:



type: boolean

required: true

description: \"true\" means this network is shared by multiple Openstack tenants

is_external_network:



type: boolean

required: true

default: false

description: |

\"true\" means this Contrail external network

ipv4_subnet_default_assignment:



type: org.openecomp.datatypes.network.IPv4SubnetAssignments

required: true

description: IPv4 defualt subnet assignments

ipv6_subnet_default_assignment:

type: org.openecomp.datatypes.network.IPv6SubnetAssignments

required: true

description: IPv6 defualt subnet assignments

related_networks:

Comment: Defined in Conformance level 9.0

type: list

description: Related Networks List.

required: false

entry_schema:

        type: org.openecomp.datatypes.network.RelatedNetworksAssignments



Comment: Defined in Conformance level 9.0

is_trunked:



Comment: Defined in Conformance level 9.0

type: boolean

required: true

description: \"true\" indicates that network is trunked

default: false

1.1.1.2.7      org.openecomp.datatypes.network.NetworkFlows



org.openecomp.datatypes.network.NetworkFlows:

    derived_from: org.openecomp.datatypes.Root

    properties:



is_network_policy:



type: boolean

required: false

default: false

description: \"true\" indicates the network has 1 or more policies



network_policy:



type: string

required: false

description: 'Identifies the specific Cloud network policy that must be applied to this network (source: from Policy Manager).'



is_bound_to_vpn:



type: boolean

required: false

default: false

description: \"true\" indicates the network has 1 or more vpn bindings



vpn_binding:



type: string

required: false

description: 'Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source: A&AI)'









1.1.1.2.8      org.openecomp.datatypes.network.ProviderNetwork



org.openecomp.datatypes.network.ProviderNetwork:

    derived_from: org.openecomp.datatypes.Root

    properties:

is_provider_network:



type: boolean

required: true

description: \"true\" indicates that this a Neutron provider type of network

physical_network_name:



type: string

required: false

constraints:

- valid_values:

    - Physnet41

    - Physnet42

    - Physnet43

    - Physnet44

    - Physnet21

    - Physnet22

    - sriovnet1

    - sriovnet2

    - oam

description: |

Identifies the NUMA processor cluster to which this physical network interface belongs. NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)

numa:



type: string

required: false

constraints:

- valid_values:

    - NUMA 0

    - NUMA 1

description: |

PNIC instance within the NUMA processor cluster PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)

pnic_instance:



type: integer

required: false

description: PNIC instance within the NUMA processor cluster

1.1.1.2.9      org.openecomp.datatypes.Naming



org.openecomp.datatypes.Naming:

     derived_from: org.openecomp.datatypes.Root

      properties:



ONAP_generated_naming:



type: boolean

required: true

default: true

description: |

"true" indicates that the name for the instance will be auto-generated by ONAP.

"false" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).



naming_policy:

type: string

required: false

 description: Reference to naming policy that ONAP will use when the name is auto-generated



instance_name:



description: indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).

type: string

required: false







1.1.1.2.10  org.openecomp.datatypes.network.MacAssignments



org.openecomp.datatypes.network.MacAssignments

     derived_from: org.openecomp.datatypes.Root

      properties:



mac_range_plan:



type: string

required: true

description: reference to a MAC address range plan



mac_count:



type: integer

required: true

 description: identifies the number of MAC addresses to assign to the CP from the plan







1.1.1.2.11  org.openecomp.datatypes.network.VlanRequirements



org.openecomp.datatypes.network.VlanRequirements

     derived_from: org.openecomp.datatypes.Root

      properties:



vlan_range_plan:

type: string

required: true

description: reference to a vlan range plan



vlan_type:

type: string

required: true

constraints:

- valid_values:

    - c-tag

    - s-tag

description: identifies the vlan type (e.g., c-tag)



vl         an_count:

type: integer

required: true

 description: identifies the number of vlan tags to assign to the CP from the plan







1.1.1.2.12  org.openecomp.datatypes.network.IpRequirements



org.openecomp.datatypes.network.IpRequirements

     derived_from: org.openecomp.datatypes.Root

      properties:



ip_version:

type: integer

required: true

constraints:

- valid_values:

    - 4

    - 6



ip_count:

description: identifies the number of ip address to assign to the CP from the plan

type: integer

required: false



floating_ip_count:

type: integer

required: false



subnet_role:

type: string

required: false



assingment_method:

type: string

required: true

constraints:

- valid_values:

   - fixed

   - dhcp



dhcp_enabled:

type: boolean

required: false



ip_count_required:

description: identifies the number of ip address to assign to the CP from the plan

type: org.openecomp.datatypes.AssignmentRequirements

required: false



floating_ip_count_required:

type: org.openecomp.datatypes.AssignmentRequirements

required: false



ip_address_plan_name:

type: string

required: false



vrf_name:

type: string

required: false









1.1.1.2.13  org.openecomp.datatypes.AssignmentRequirements



org.openecomp.datatypes.AssignmentRequirements:

    derived_from: org.openecomp.datatypes.Root

    properties:



is_required:

is_required:

description: |

"true" indicates that assignment is required

type: boolean

default: false

required: true



count:

description: number of assignments required

type: integer

required: false









1.1.1.2.14   org.openecomp.datatypes.flavors.DeploymentFlavor

This is data type contains the definitions of all properties that make a deployment flavor. It directly includes two properties:

-          name –intended to keep a human-readable name of the flavor

-          ONAP_part_number – an ONAP alias for the AT&T part number (used to be <att_part_number> in the pre-load XMLs)

All other properties are enclosed into complex-typed sub-properties. The auxiliary data types used for them are ComputeFlavor, LicenseFlavor, and VendorInfo.



data_types:

  org.openecomp.datatypes.flavors.DeploymentFlavor:

    properties:





sp_part_number:

type: string



vendor_info:

type: org.opencomp.datatypes.VendorInfo



compute_flavor:

type: org.opencomp.datatypes.flavors.ComputeFlavor



license_flavor:

type: org.opencomp.datatypes.flavors.LicenseFlavor, required: false

if this property is missing, then the flavor does not have a license









1.1.1.2.15   org.openecomp.datatypes.flavors.ComputeFlavor

This data type gathers all deployment flavor properties related to capacity.

data_types:

  org.openecomp.datatypes.flavors.ComputeFlavor:

    properties:



num_cpus:

type: integer



disk_size:

type: scalar-unit.size



mem_size:

type: scalar-unit.size









Please note that the data type of the disk_size and the mem_size properties is scalar-unit.size. This is the TOSCA way to say that the orchestrator expects their values to come with a size qualifier – 16 GB, 512MB, etc.

1.1.1.2.16   org.openecomp.datatypes.flavors.LicenseFlavor

This LicenseFlavor data type groups the flavor properties related to licensing. Currently it contains only one property, feature_group_uuid, which is a reference to a group of licensed features within an external document. In the future, more properties can be added.



data_types:

  org.openecomp.datatypes.flavors.LicenseFlavor:

    properties:

      feature_group_uuid: {type: string}

1.1.1.2.17   org.openecomp.datatypes.flavors.VendorInfo

The VNF node template already contains metadata parameters resourceVendor and resourceVendorRelease to descript the vendor-specific details common for the whole VNF. The VendorInfo data type serves to define vendor details that vary in different deployment flavors.

data_types:

  org.openecomp.datatypes.flavors.VendorInfo:

    properties:



manufacturer_reference_number:

type: string



vendor_model:

type: string









1.1.1.2.18  org.openecomp.datatypes.ImageInfo

A flavored VFC comes with one or more images. The properties of the ImageInfo data type describe such an image.

data_types:

  org.openecomp.datatypes.ImageInfo:

    properties:



software_version:

type: string



file_name:

type: string



file_hash:

type: string

description: checksum/signature



file_hash_type:

type: string

required: false

default: md5









1.1.1.2.19   org.openecomp.datatypes.PortMirroringConnectionPointDescription

This complex TOSCA data type gathers and conveys information about a connection point participating in port mirroring. The same type is used to describe connection points on both the source and collector sides on the Port Mirroring service.

data_types:

    org.openecomp.datatypes.PortMirroringConnectionPointDescription:

        properties:



nf_naming_code:

type: string



nfc_naming_code:

type: string



nf_type:

type: string

Deprecated; Conf Level 8.0



nfc_type:

type: string

Deprecated; Conf Level 8.0



network_role:

type: string



pps_capacity:

type: string









1.1.1.2.20 org.openecomp.datatypes.RelatedNetworksAssignments



data_types:

  org.openecomp.datatypes.RelatedNetworksAssignments:

      derived_from: org.openecomp.datatypes.Root

           properties:



related_network_role:

type: string

description: The network role of the related network, sharing provider network

required: false