+#
+# ============LICENSE_START=======================================================
+# org.onap.aai
+# ================================================================================
+# Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ============LICENSE_END=========================================================
+#
+# ECOMP is a trademark and service mark of AT&T Intellectual Property.
+#
+
swagger: "2.0"
info:
description: |
$ref: "#/definitions/vces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/vpes/vpe/{vnf-id}/relationship-list/relationship:
+ /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeRelationshipListRelationship
+ operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeRelationshipListRelationship
+ operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
- put:
+ /network/vnfcs/vnfc/{vnfc-name}:
+ get:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns vnfc
+ description: returns vnfc
+ operationId: getNetworkVnfcsVnfc
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vnfc"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
+ - name: vnfc-function-code
+ in: query
+ description: function code
+ required: false
type: string
- - name: vlan-interface
+ - name: vnfc-type
+ in: query
+ description: type
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: prov status of this vnfc
+ required: false
+ type: string
+ - name: ipaddress-v4-oam-vip
+ in: query
+ description: Oam V4 vip address of this vnfc
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: group-notation
+ in: query
+ description: Group notation of VNFC
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vnfc
+ description: create or update an existing vnfc
+ operationId: createOrUpdateNetworkVnfcsVnfc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
in: path
- description: String that identifies the interface
+ description: Unique ID of vnfc.
required: true
type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: vnfc object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/vnfc"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ summary: delete an existing vnfc
+ description: delete an existing vnfc
+ operationId: deleteNetworkVnfcsVnfc
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
+ - name: vnfc-name
in: path
- description: Name given to the interface
+ description: Unique ID of vnfc.
required: true
type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ /network/vnfcs:
+ get:
+ tags:
+ - Network
+ summary: returns vnfcs
+ description: returns vnfcs
+ operationId: getNetworkVnfcs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vnfcs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
+ - name: network-id
in: path
- description: String that identifies the interface
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: l3-interface-ipv4-address
+ - name: subnet-id
in: path
- description: IP address
+ description: Subnet ID, should be UUID.
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
+ - name: network-id
in: path
- description: String that identifies the interface
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: l3-interface-ipv4-address
+ - name: subnet-id
in: path
- description: IP address
+ description: Subnet ID, should be UUID.
required: true
type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
get:
tags:
- Network
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: returns subnet
+ description: returns subnet
+ operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/definitions/subnet"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
+ - name: network-id
in: path
- description: String that identifies the interface
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: l3-interface-ipv4-address
+ - name: subnet-id
in: path
- description: IP address
+ description: Subnet ID, should be UUID.
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
+ - name: network-name
in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ description: Name of the network, governed by some naming convention..
required: false
type: string
- name: service-id
description: Unique identifier of service from ASDC
required: false
type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- name: heat-stack-id
in: query
description: Heat stack id corresponding to this instance, managed by MSO
required: false
type: string
- - name: interface-id
+ - name: contrail-network-fqdn
in: query
- description: ID of interface
+ description: Contrail FQDN for the network
required: false
type: string
- - name: macaddr
+ - name: persona-model-id
in: query
- description: MAC address for the interface
+ description: the ASDC model id for this resource or service model.
required: false
type: string
- - name: network-name
+ - name: persona-model-version
in: query
- description: Name of the network
+ description: the ASDC model version for this resource or service model.
required: false
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
+ - name: widget-model-id
in: query
- description: This indicates the customers VPN ID associated with this vlan
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
required: false
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
+ - name: widget-model-version
in: query
- description: Neutron network id of the interface that address belongs to
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
required: false
type: string
- - name: neutron-subnet-id
+ - name: subnet-name
in: query
- description: Neutron id of subnet that address belongs to
+ description: Name associated with the subnet.
required: false
type: string
put:
tags:
- Network
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: create or update an existing subnet
+ description: create or update an existing subnet
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
+ - name: network-id
in: path
- description: String that identifies the interface
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: l3-interface-ipv4-address
+ - name: subnet-id
in: path
- description: IP address
+ description: Subnet ID, should be UUID.
required: true
type: string
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: subnet object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/definitions/subnet"
delete:
tags:
- Network
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: delete an existing subnet
+ description: delete an existing subnet
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: network-id
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: interface-name
+ - name: subnet-id
in: path
- description: Name given to the interface
+ description: Subnet ID, should be UUID.
required: true
type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
type: string
- - name: l3-interface-ipv4-address
+ /network/l3-networks/l3-network/{network-id}/subnets:
+ get:
+ tags:
+ - Network
+ summary: returns subnets
+ description: returns subnets
+ operationId: getNetworkL3NetworksL3NetworkSubnets
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/subnets"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
in: path
- description: IP address
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: resource-version
+ - name: network-name
in: query
- description: resource-version for concurrency
- required: true
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: persona-model-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: persona-model-version
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
+ - name: network-id
in: path
- description: String that identifies the interface
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: vlan-id-inner
in: path
- description: IP address
+ description: id.
required: true
- type: string
+ type: integer
+ format: int64
- name: body
in: body
description: relationship object that needs to be created or updated
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
+ - name: network-id
in: path
- description: String that identifies the interface
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: vlan-id-inner
in: path
- description: IP address
+ description: id.
required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
+ type: integer
+ format: int64
+ /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
get:
tags:
- Network
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: returns ctag-assignment
+ description: returns ctag-assignment
+ operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/ctag-assignment"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
+ - name: network-id
in: path
- description: String that identifies the interface
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: vlan-id-inner
in: path
- description: IP address
+ description: id.
required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
+ type: integer
+ format: int64
+ - name: network-name
in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ description: Name of the network, governed by some naming convention..
required: false
type: string
- name: service-id
description: Unique identifier of service from ASDC
required: false
type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- name: heat-stack-id
in: query
description: Heat stack id corresponding to this instance, managed by MSO
required: false
type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
+ - name: contrail-network-fqdn
in: query
- description: MAC address for the interface
+ description: Contrail FQDN for the network
required: false
type: string
- - name: network-name
+ - name: persona-model-id
in: query
- description: Name of the network
+ description: the ASDC model id for this resource or service model.
required: false
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
+ - name: persona-model-version
in: query
- description: This indicates the customers VPN ID associated with this vlan
+ description: the ASDC model version for this resource or service model.
required: false
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
+ - name: widget-model-id
in: query
- description: Neutron network id of the interface that address belongs to
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
required: false
type: string
- - name: neutron-subnet-id
+ - name: widget-model-version
in: query
- description: Neutron id of subnet that address belongs to
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
required: false
type: string
put:
tags:
- Network
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: create or update an existing ctag-assignment
+ description: create or update an existing ctag-assignment
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: network-id
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: interface-name
+ - name: vlan-id-inner
in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- delete:
- tags:
- - Network
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
- get:
- tags:
- - Network
- summary: returns vlan
- description: returns vlan
- operationId: getNetworkVpesVpeLInterfacesLInterfaceVlansVlan
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vlan"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing vlan
- description: create or update an existing vlan
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlan
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: body
- in: body
- description: vlan object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/vlan"
- delete:
- tags:
- - Network
- summary: delete an existing vlan
- description: delete an existing vlan
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlan
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
- get:
- tags:
- - Network
- summary: returns vlans
- description: returns vlans
- operationId: getNetworkVpesVpeLInterfacesLInterfaceVlans
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vlans"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
- get:
- tags:
- - Network
- summary: returns sriov-vf
- description: returns sriov-vf
- operationId: getNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVf
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/sriov-vf"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVf
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- - name: body
- in: body
- description: sriov-vf object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/sriov-vf"
- delete:
- tags:
- - Network
- summary: delete an existing sriov-vf
- description: delete an existing sriov-vf
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVf
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
- get:
- tags:
- - Network
- summary: returns sriov-vfs
- description: returns sriov-vfs
- operationId: getNetworkVpesVpeLInterfacesLInterfaceSriovVfs
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/sriov-vfs"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
- get:
- tags:
- - Network
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
- tags:
- - Network
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
- get:
- tags:
- - Network
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- delete:
- tags:
- - Network
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}:
- get:
- tags:
- - Network
- summary: returns l-interface
- description: returns l-interface
- operationId: getNetworkVpesVpeLInterfacesLInterface
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l-interface"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing l-interface
- description: create or update an existing l-interface
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterface
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: body
- in: body
- description: l-interface object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/l-interface"
- delete:
- tags:
- - Network
- summary: delete an existing l-interface
- description: delete an existing l-interface
- operationId: deleteNetworkVpesVpeLInterfacesLInterface
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces:
- get:
- tags:
- - Network
- summary: returns l-interfaces
- description: returns l-interfaces
- operationId: getNetworkVpesVpeLInterfaces
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l-interfaces"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
- get:
- tags:
- - Network
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
- tags:
- - Network
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
- get:
- tags:
- - Network
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- delete:
- tags:
- - Network
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
- get:
- tags:
- - Network
- summary: returns vlan
- description: returns vlan
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vlan"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing vlan
- description: create or update an existing vlan
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: body
- in: body
- description: vlan object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/vlan"
- delete:
- tags:
- - Network
- summary: delete an existing vlan
- description: delete an existing vlan
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
- get:
- tags:
- - Network
- summary: returns vlans
- description: returns vlans
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vlans"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
- get:
- tags:
- - Network
- summary: returns sriov-vf
- description: returns sriov-vf
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/sriov-vf"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- - name: body
- in: body
- description: sriov-vf object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/sriov-vf"
- delete:
- tags:
- - Network
- summary: delete an existing sriov-vf
- description: delete an existing sriov-vf
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
- get:
- tags:
- - Network
- summary: returns sriov-vfs
- description: returns sriov-vfs
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/sriov-vfs"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
- get:
- tags:
- - Network
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
- tags:
- - Network
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
- get:
- tags:
- - Network
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- delete:
- tags:
- - Network
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
- get:
- tags:
- - Network
- summary: returns l-interface
- description: returns l-interface
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l-interface"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing l-interface
- description: create or update an existing l-interface
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: body
- in: body
- description: l-interface object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/l-interface"
- delete:
- tags:
- - Network
- summary: delete an existing l-interface
- description: delete an existing l-interface
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
- get:
- tags:
- - Network
- summary: returns l-interfaces
- description: returns l-interfaces
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfaces
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l-interfaces"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
- get:
- tags:
- - Network
- summary: returns lag-interface
- description: returns lag-interface
- operationId: getNetworkVpesVpeLagInterfacesLagInterface
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/lag-interface"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing lag-interface
- description: create or update an existing lag-interface
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterface
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: body
- in: body
- description: lag-interface object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/lag-interface"
- delete:
- tags:
- - Network
- summary: delete an existing lag-interface
- description: delete an existing lag-interface
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterface
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces:
- get:
- tags:
- - Network
- summary: returns lag-interfaces
- description: returns lag-interfaces
- operationId: getNetworkVpesVpeLagInterfaces
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/lag-interfaces"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- /network/vpes/vpe/{vnf-id}:
- get:
- tags:
- - Network
- summary: returns vpe
- description: returns vpe
- operationId: getNetworkVpesVpe
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vpe"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing vpe
- description: create or update an existing vpe
- operationId: createOrUpdateNetworkVpesVpe
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: body
- in: body
- description: vpe object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/vpe"
- delete:
- tags:
- - Network
- summary: delete an existing vpe
- description: delete an existing vpe
- operationId: deleteNetworkVpesVpe
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpes:
- get:
- tags:
- - Network
- summary: returns vpes
- description: returns vpes
- operationId: getNetworkVpes
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vpes"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnfc-name
- in: path
- description: Unique ID of vnfc.
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnfc-name
- in: path
- description: Unique ID of vnfc.
- required: true
- type: string
- /network/vnfcs/vnfc/{vnfc-name}:
- get:
- tags:
- - Network
- summary: returns vnfc
- description: returns vnfc
- operationId: getNetworkVnfcsVnfc
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vnfc"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnfc-name
- in: path
- description: Unique ID of vnfc.
- required: true
- type: string
- - name: vnfc-function-code
- in: query
- description: function code
- required: false
- type: string
- - name: vnfc-type
- in: query
- description: type
- required: false
- type: string
- - name: prov-status
- in: query
- description: prov status of this vnfc
- required: false
- type: string
- - name: ipaddress-v4-oam-vip
- in: query
- description: Oam V4 vip address of this vnfc
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: group-notation
- in: query
- description: Group notation of VNFC
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing vnfc
- description: create or update an existing vnfc
- operationId: createOrUpdateNetworkVnfcsVnfc
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnfc-name
- in: path
- description: Unique ID of vnfc.
- required: true
- type: string
- - name: body
- in: body
- description: vnfc object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/vnfc"
- delete:
- tags:
- - Network
- summary: delete an existing vnfc
- description: delete an existing vnfc
- operationId: deleteNetworkVnfcsVnfc
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnfc-name
- in: path
- description: Unique ID of vnfc.
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vnfcs:
- get:
- tags:
- - Network
- summary: returns vnfcs
- description: returns vnfcs
- operationId: getNetworkVnfcs
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vnfcs"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: network-id
- in: path
- description: Network ID, should be uuid. Unique across A&AI.
- required: true
- type: string
- - name: subnet-id
- in: path
- description: Subnet ID, should be UUID.
- required: true
- type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: network-id
- in: path
- description: Network ID, should be uuid. Unique across A&AI.
- required: true
- type: string
- - name: subnet-id
- in: path
- description: Subnet ID, should be UUID.
- required: true
- type: string
- /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
- get:
- tags:
- - Network
- summary: returns subnet
- description: returns subnet
- operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/subnet"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: network-id
- in: path
- description: Network ID, should be uuid. Unique across A&AI.
- required: true
- type: string
- - name: subnet-id
- in: path
- description: Subnet ID, should be UUID.
- required: true
- type: string
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: subnet-name
- in: query
- description: Name associated with the subnet.
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing subnet
- description: create or update an existing subnet
- operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: network-id
- in: path
- description: Network ID, should be uuid. Unique across A&AI.
- required: true
- type: string
- - name: subnet-id
- in: path
- description: Subnet ID, should be UUID.
- required: true
- type: string
- - name: body
- in: body
- description: subnet object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/subnet"
- delete:
- tags:
- - Network
- summary: delete an existing subnet
- description: delete an existing subnet
- operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: network-id
- in: path
- description: Network ID, should be uuid. Unique across A&AI.
- required: true
- type: string
- - name: subnet-id
- in: path
- description: Subnet ID, should be UUID.
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/l3-networks/l3-network/{network-id}/subnets:
- get:
- tags:
- - Network
- summary: returns subnets
- description: returns subnets
- operationId: getNetworkL3NetworksL3NetworkSubnets
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/subnets"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: network-id
- in: path
- description: Network ID, should be uuid. Unique across A&AI.
- required: true
- type: string
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: network-id
- in: path
- description: Network ID, should be uuid. Unique across A&AI.
- required: true
- type: string
- - name: vlan-id-inner
- in: path
- description: id.
- required: true
- type: integer
- format: int64
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: network-id
- in: path
- description: Network ID, should be uuid. Unique across A&AI.
- required: true
- type: string
- - name: vlan-id-inner
- in: path
- description: id.
- required: true
- type: integer
- format: int64
- /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
- get:
- tags:
- - Network
- summary: returns ctag-assignment
- description: returns ctag-assignment
- operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/ctag-assignment"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: network-id
- in: path
- description: Network ID, should be uuid. Unique across A&AI.
- required: true
- type: string
- - name: vlan-id-inner
- in: path
- description: id.
- required: true
- type: integer
- format: int64
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing ctag-assignment
- description: create or update an existing ctag-assignment
- operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: network-id
- in: path
- description: Network ID, should be uuid. Unique across A&AI.
- required: true
- type: string
- - name: vlan-id-inner
- in: path
- description: id.
+ description: id.
required: true
type: integer
format: int64
ctag-pool:
description: |
A collection of C tags (vlan tags) grouped for a specific purpose.
+ ###### Related Nodes
+ - TO availability-zone (Many2Many)
+ - FROM complex (is composed of ctag-pool)
+ - FROM vpls-pe
required:
- target-pe
- availability-zone-name
complex:
description: |
Collection of physical locations that can house cloud-regions.
+ ###### Related Nodes
+ - TO ctag-pool (comprises complex, Many2Many)
+ - TO l3-network (Many2Many)
+ - FROM availability-zone
+ - FROM cloud-region
+ - FROM oam-network
+ - FROM pserver
+ - FROM pnf
+ - FROM vce
+ - FROM vpls-pe
+ - FROM volume-group
required:
- physical-location-id
- physical-location-type
###### Default Delete Scope
THIS_NODE_ONLY
###### Related Nodes
+ - TO complex (Many2Many)
- TO tenant (Many2Many)
- FROM cloud-region (is composed of volume-group)
- FROM vf-module
###### Related Nodes
- TO l3-interface-ipv4-address-list (comprises vlan, Many2Many)
- TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
- - TO logical-link (Many2Many, will delete target node)
+ - TO multicast-configuration (Many2Many)
+ - TO logical-link (One2One)
- FROM l-interface (is composed of vlan)
- FROM service-instance
required:
sriov-vf:
description: |
SR-IOV Virtual Function (not to be confused with virtual network function)
+ ###### Related Nodes
+ - FROM l-interface (is composed of sriov-vf)
required:
- pci-id
properties:
###### Related Nodes
- TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
- TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
- - TO logical-link (Many2Many, will delete target node)
+ - TO logical-link (Many2Many)
- TO vlan (comprises l-interface, Many2Many)
+ - TO sriov-vf (comprises l-interface, One2One)
- FROM generic-vnf (is composed of l-interface)
- FROM lag-interface (is composed of l-interface)
+ - FROM newvce (is composed of l-interface)
- FROM p-interface (is composed of l-interface)
- FROM vserver (is composed of l-interface)
required:
###### Related Nodes
- TO flavor (Many2One)
- TO image (Many2One)
- - TO ipaddress (comprises vserver, Many2Many)
- TO l-interface (comprises vserver, Many2Many)
- TO pserver (Many2One)
- TO volume (comprises vserver, Many2Many)
- TO vf-module (Many2One)
- FROM generic-vnf
- FROM tenant (is composed of vserver)
+ - FROM vce
required:
- vserver-id
- vserver-name
THIS_NODE_ONLY
###### Related Nodes
- FROM image (is composed of metadatum)
+ - FROM model (is composed of metadatum)
- FROM service-instance (is composed of metadatum)
+ - FROM connector (is composed of metadatum)
required:
- metaname
- metaval
Collection of metadatum (key/value pairs)
###### Default Delete Scope
THIS_NODE_ONLY
- ###### Related Nodes
- - FROM image (is composed of metadata)
properties:
metadatum:
type: array
###### Default Delete Scope
ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- - TO metadata (comprises image, Many2Many)
- TO metadatum (comprises image, Many2Many)
- FROM cloud-region (is composed of image)
- FROM vserver
dvs-switch:
description: |
Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
+ ###### Related Nodes
+ - TO availability-zone (Many2Many)
+ - FROM cloud-region (is composed of dvs-switch)
required:
- switch-name
- vcenter-url
$ref: "#/definitions/relationship"
dvs-switches:
description: |
- Collection of digital virtual switch metadata used for vmWare VCEs and VPEs.
+ Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
properties:
dvs-switch:
type: array
oam-network:
description: |
OAM network, to be deprecated shortly. Do not use for new purposes.
+ ###### Related Nodes
+ - TO complex (Many2Many)
+ - TO service-capability (Many2Many)
+ - FROM cloud-region (is composed of oam-network)
required:
- network-uuid
- network-name
###### Default Delete Scope
ERROR_IF_ANY_IN_EDGES
###### Related Nodes
+ - TO complex (Many2Many)
+ - TO service-capability (Many2Many)
- FROM cloud-region (is composed of availability-zone)
+ - FROM ctag-pool
+ - FROM dvs-switch
- FROM generic-vnf
- FROM pserver
+ - FROM vce
required:
- availability-zone-name
- hypervisor-type
$ref: "#/definitions/availability-zone"
cloud-region:
description: |
- cloud-region designates an installation of a cloud cluster or region or instantiation. In AT&Ts AIC cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname and we will use att-aic for AT&T's AIC.
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
###### Default Delete Scope
THIS_NODE_ONLY
###### Related Nodes
+ - TO complex (Many2One)
- TO l3-network (Many2Many)
- TO tenant (comprises cloud-region, One2Many)
- TO image (comprises cloud-region, One2Many)
- TO flavor (comprises cloud-region, One2Many)
- TO availability-zone (comprises cloud-region, One2Many)
+ - TO oam-network (comprises cloud-region, One2Many)
+ - TO dvs-switch (comprises cloud-region, One2Many)
- TO volume-group (comprises cloud-region, One2Many)
- TO group-assignment (comprises cloud-region, One2Many)
- TO snapshot (comprises cloud-region, One2Many)
network-profile:
description: |
Network profile populated by SDN-GP for SNMP
+ ###### Related Nodes
+ - FROM generic-vnf
required:
- nm-profile-name
properties:
CASCADE_TO_CHILDREN
###### Related Nodes
- TO l-interface (comprises p-interface, Many2Many)
- - TO physical-link (Many2Many, will delete target node)
+ - TO physical-link (Many2Many)
- TO logical-link (Many2One)
- FROM lag-interface
- FROM pserver (is composed of p-interface)
- FROM pnf (is composed of p-interface)
+ - FROM vpls-pe (is composed of p-interface)
required:
- interface-name
properties:
###### Default Delete Scope
CASCADE_TO_CHILDREN
###### Related Nodes
+ - TO lag-link (Many2Many)
- TO p-interface (Many2Many)
- TO l-interface (comprises lag-interface, Many2Many)
- FROM generic-vnf (is composed of lag-interface)
- FROM pserver (is composed of lag-interface)
- FROM pnf (is composed of lag-interface)
+ - FROM vpls-pe (is composed of lag-interface)
required:
- interface-name
properties:
###### Default Delete Scope
ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
+ - TO complex (Many2One)
- TO cloud-region (Many2One)
- TO availability-zone (Many2One)
- TO lag-interface (comprises pserver, Many2Many)
virtual-data-center:
description: |
Virtual organization of cloud infrastructure elements in a data center context
+ ###### Related Nodes
+ - TO generic-vnf (Many2Many)
+ - TO logical-link (Many2Many)
+ - FROM connector
required:
- vdc-id
- vdc-name
connector:
description: |
Collection of resource instances used to connect a variety of disparate inventory widgets
+ ###### Related Nodes
+ - TO virtual-data-center (Many2Many)
+ - TO metadatum (comprises connector, Many2Many)
+ - FROM service-instance
required:
- resource-instance-id
properties:
###### Default Delete Scope
CASCADE_TO_CHILDREN
###### Related Nodes
- - TO pnf (One2Many)
+ - TO cvlan-tag (Many2Many)
+ - TO connector (Many2Many)
- TO metadatum (comprises service-instance, Many2Many)
- - TO logical-link (Many2Many, will delete target node)
+ - TO logical-link (Many2Many)
- TO vlan (One2Many)
- TO service-instance (One2Many)
- FROM generic-vnf
- FROM l3-network
- FROM service-subscription (is composed of service-instance)
+ - FROM vce
- FROM service-instance
required:
- service-instance-id
vnf-image:
description: |
Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ ###### Related Nodes
+ - FROM generic-vnf
required:
- vnf-image-uuid
- application
service-capability:
description: |
Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
+ ###### Related Nodes
+ - FROM availability-zone
+ - FROM oam-network
required:
- service-type
- vnf-type
###### Default Delete Scope
CASCADE_TO_CHILDREN
###### Related Nodes
+ - TO model (Many2One)
- TO model-element (comprises model-element, One2Many)
- TO model-constraint (comprises model-element, One2Many)
- TO constrained-element-set (comprises model-element, One2Many)
- - FROM model-element (is composed of model-element)
+ - FROM model (is composed of model-element)
- FROM element-choice-set (is composed of model-element)
+ - FROM model-element (is composed of model-element)
required:
- model-element-uuid
- new-data-del-flag
###### Default Delete Scope
ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
+ - TO model (Many2One)
+ - TO model-element (comprises model, One2Many)
+ - TO metadatum (comprises model, One2Many)
+ - FROM model-element
- FROM named-query
- FROM named-query-element
required:
###### Default Delete Scope
THIS_NODE_ONLY
###### Related Nodes
+ - TO lag-link (Many2Many)
- TO pnf (Many2Many)
- TO logical-link (One2Many)
- TO generic-vnf (Many2Many)
- TO pserver (Many2Many)
- FROM l-interface
- - FROM logical-link
- FROM p-interface
- FROM service-instance
+ - FROM virtual-data-center
- FROM vlan
+ - FROM logical-link
required:
- link-name
- link-type
items:
$ref: "#/definitions/logical-link"
class-of-service:
+ description: |
+ ###### Related Nodes
+ - FROM site-pair (is composed of class-of-service)
required:
- cos
properties:
items:
$ref: "#/definitions/class-of-service"
site-pair:
+ description: |
+ ###### Related Nodes
+ - TO class-of-service (comprises site-pair, Many2Many)
+ - FROM routing-instance (is composed of site-pair)
required:
- site-pair-id
properties:
items:
$ref: "#/definitions/site-pair"
routing-instance:
+ description: |
+ ###### Related Nodes
+ - TO site-pair (comprises routing-instance, Many2Many)
+ - FROM site-pair-set (is composed of routing-instance)
required:
- routing-instance-id
properties:
site-pair-set:
description: |
Set of instances for probes used to measure service level agreements
+ ###### Related Nodes
+ - TO routing-instance (comprises site-pair-set, Many2Many)
+ - FROM generic-vnf
required:
- site-pair-set-id
properties:
vpn-binding:
description: |
VPN binding
+ ###### Related Nodes
+ - FROM l3-network
required:
- vpn-id
- vpn-name
vpls-pe:
description: |
VPLS Provider Edge routers.
+ ###### Related Nodes
+ - TO complex (Many2Many)
+ - TO ctag-pool (Many2Many)
+ - TO p-interface (comprises vpls-pe, Many2Many)
+ - TO lag-interface (comprises vpls-pe, Many2Many)
required:
- equipment-name
properties:
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
ipv4-oam-address:
type: string
- description: Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
equipment-role:
type: string
description: Client should send valid enumerated value, e.g., VPLS-PE.
items:
$ref: "#/definitions/vpls-pe"
multicast-configuration:
+ description: |
+ ###### Related Nodes
+ - FROM vlan
required:
- multicast-configuration-id
- multicast-protocol
port-group:
description: |
Used to capture the network interfaces of this VCE
+ ###### Related Nodes
+ - TO cvlan-tag (comprises port-group, Many2Many)
+ - FROM vce (is composed of port-group)
required:
- interface-id
- orchestration-status
vce:
description: |
Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
+ ###### Related Nodes
+ - TO availability-zone (Many2Many)
+ - TO complex (Many2Many)
+ - TO port-group (comprises vce, Many2Many)
+ - TO vserver (Many2Many)
+ - TO service-instance (Many2Many)
required:
- vnf-id
- vnf-name
type: array
items:
$ref: "#/definitions/vce"
- vpe:
- description: |
- Relationship-list must include related to info for complex.
- required:
- - vnf-id
- - vnf-name
- - vnf-type
- properties:
- vnf-id:
- type: string
- description: Unique id of VNF. This is unique across the graph.
- vnf-name:
- type: string
- description: Name of VNF.
- vnf-name2:
- type: string
- description: Alternate name of VNF.
- vnf-type:
- type: string
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- service-id:
- type: string
- description: Unique identifier of service from ASDC
- regional-resource-zone:
- type: string
- description: Regional way of organizing pservers, source of truth should define values
- prov-status:
- type: string
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- operational-state:
- type: string
- description: Indicator for whether the resource is considered operational
- license-key:
- type: string
- description: License key
- equipment-role:
- type: string
- description: Client should send valid enumerated value
- orchestration-status:
- type: string
- description: Orchestration status of this VNF, mastered by MSO
- heat-stack-id:
- type: string
- description: Heat stack id corresponding to this instance, managed by MSO
- mso-catalog-key:
- type: string
- description: Corresponds to the SDN-C catalog id used to configure this VCE
- ipv4-oam-address:
- type: string
- description: Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
- ipv4-oam-gateway-address-prefix-length:
- type: integer
- format: int32
- description: Prefix length for oam-address
- ipv4-oam-gateway-address:
- type: string
- description: Gateway address
- v4-loopback0-ip-address:
- type: string
- description: Loopback0 address
- vlan-id-outer:
- type: integer
- format: int64
- description: Temporary location for stag to get to VCE
- as-number:
- type: string
- description: as-number of the VPE
- resource-version:
- type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- summary-status:
- type: string
- description: details regarding the vpe operation
- encrypted-access-flag:
- type: boolean
- description: indicates whether vpe access uses SSH
- relationship-list:
- type: array
- items:
- $ref: "#/definitions/relationship"
- l-interfaces:
- type: array
- items:
- $ref: "#/definitions/l-interface"
- lag-interfaces:
- type: array
- items:
- $ref: "#/definitions/lag-interface"
- vpes:
- description: |
- Virtual provider edge router. In 1504, A&AI will populate this object through an M&P and tool provided to operations.
- properties:
- vpe:
- type: array
- items:
- $ref: "#/definitions/vpe"
vnfc:
description: |
###### Default Delete Scope
subnet:
description: |
###### Default Delete Scope
- THIS_NODE_ONLY
+ ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- FROM l3-interface-ipv4-address-list
- FROM l3-interface-ipv6-address-list
###### Default Delete Scope
CASCADE_TO_CHILDREN
###### Related Nodes
+ - TO vpn-binding (Many2Many)
- TO subnet (comprises l3-network, Many2Many)
- TO service-instance (Many2Many)
- TO ctag-assignment (comprises l3-network, Many2Many)
+ - TO network-policy (Many2Many)
- TO segmentation-assignment (comprises l3-network, One2Many)
+ - TO route-table-reference (Many2Many)
- FROM cloud-region
+ - FROM complex
- FROM generic-vnf
- FROM l3-interface-ipv4-address-list
- FROM l3-interface-ipv6-address-list
items:
$ref: "#/definitions/l3-network"
network-policy:
+ description: |
+ ###### Related Nodes
+ - FROM l3-network
required:
- network-policy-id
properties:
###### Related Nodes
- TO volume-group (One2One)
- TO l3-network (Many2Many)
- - TO vnfc (One2Many, will delete target node)
+ - TO vnfc (One2Many)
- FROM vserver
- FROM generic-vnf (is composed of vf-module)
required:
###### Default Delete Scope
CASCADE_TO_CHILDREN
###### Related Nodes
+ - TO license-key-resource (Many2Many)
- TO l-interface (comprises generic-vnf, Many2Many)
- TO availability-zone (Many2Many)
- TO lag-interface (comprises generic-vnf, Many2Many)
- TO l3-network (Many2Many)
- TO pserver (Many2Many)
+ - TO vnf-image (Many2One)
- TO vserver (One2Many)
- TO service-instance (Many2Many)
+ - TO site-pair-set (Many2Many)
+ - TO network-profile (Many2Many)
+ - TO ipsec-configuration (Many2One)
- TO vf-module (comprises generic-vnf, One2Many)
- TO volume-group (One2Many)
- - TO vnfc (One2Many, will delete target node)
+ - TO vnfc (One2Many)
+ - FROM virtual-data-center
- FROM logical-link
required:
- vnf-id
lag-link:
description: |
LAG links can connect lag-interfaces
+ ###### Related Nodes
+ - FROM lag-interface
+ - FROM logical-link
required:
- link-name
properties:
newvce:
description: |
This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ ###### Related Nodes
+ - TO l-interface (comprises newvce, Many2Many)
required:
- vnf-id2
- vnf-name
description: License key
ipv4-oam-address:
type: string
- description: Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
equipment-role:
type: string
- description: Client should send valid enumerated value, e.g., VPE.
+ description: Client should send valid enumerated value.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
###### Related Nodes
- TO p-interface (comprises pnf, Many2Many)
- TO lag-interface (comprises pnf, One2Many)
+ - TO complex (Many2One)
- FROM logical-link
- - FROM service-instance
required:
- pnf-name
- in-maint
vig-server:
description: |
vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
+ ###### Related Nodes
+ - FROM ipsec-configuration (is composed of vig-server)
required:
- vig-address-type
properties:
ipsec-configuration:
description: |
IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
+ ###### Related Nodes
+ - TO vig-server (comprises ipsec-configuration, One2Many)
+ - FROM generic-vnf
required:
- ipsec-configuration-id
properties:
route-table-reference:
description: |
Openstack route table reference.
+ ###### Related Nodes
+ - FROM l3-network
required:
- route-table-reference-id
- route-table-reference-fqdn
type: array
items:
$ref: "#/definitions/vce"
- vpes:
- type: array
- items:
- $ref: "#/definitions/vpe"
vnfcs:
type: array
items:
Code Review / aai / aai-common.git / blobdiff