+#
+# ============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: |
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- 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: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
+ - name: tenant-context
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
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
- 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: cloud-owner
- in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
- required: true
- type: string
- - name: cloud-region-id
- in: path
- description: Identifier used by the vendor for the region. Second part of composite key
- required: true
- type: string
- - name: tenant-id
- in: path
- description: Unique id relative to the cloud-region.
- required: true
- type: string
- - name: vserver-id
- in: path
- description: Unique identifier for this vserver relative to its tenant
- 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:
- - CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
- 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: cloud-owner
- in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
- required: true
- type: string
- - name: cloud-region-id
- in: path
- description: Identifier used by the vendor for the region. Second part of composite key
- required: true
- type: string
- - name: tenant-id
- in: path
- description: Unique id relative to the cloud-region.
- required: true
- type: string
- - name: vserver-id
- in: path
- description: Unique identifier for this vserver relative to its tenant
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- 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: cloud-owner
- in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
- required: true
- type: string
- - name: cloud-region-id
- in: path
- description: Identifier used by the vendor for the region. Second part of composite key
- required: true
- type: string
- - name: tenant-id
- in: path
- description: Unique id relative to the cloud-region.
- required: true
- type: string
- - name: vserver-id
- in: path
- description: Unique identifier for this vserver relative to its tenant
- 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:
- - CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- 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: cloud-owner
- in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
- required: true
- type: string
- - name: cloud-region-id
- in: path
- description: Identifier used by the vendor for the region. Second part of composite key
- required: true
- type: string
- - name: tenant-id
- in: path
- description: Unique id relative to the cloud-region.
- required: true
- type: string
- - name: vserver-id
- in: path
- description: Unique identifier for this vserver relative to its tenant
- 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
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
- get:
- tags:
- - CloudInfrastructure
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
- 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: cloud-owner
- in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
- required: true
- type: string
- - name: cloud-region-id
- in: path
- description: Identifier used by the vendor for the region. Second part of composite key
- required: true
- type: string
- - name: tenant-id
- in: path
- description: Unique id relative to the cloud-region.
- required: true
- type: string
- - name: vserver-id
- in: path
- description: Unique identifier for this vserver relative to its tenant
- 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: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
+ description: This field will store the tenant context.
required: false
type: string
- name: vserver-name
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
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
consumes:
- application/json
- application/xml
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
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
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/definitions/relationship"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
consumes:
- application/json
- application/xml
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
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
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Name given to the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: l3-interface-ipv4-address
in: path
description: IP address
required: true
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Name given to the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
get:
tags:
- CloudInfrastructure
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Name given to the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: l3-interface-ipv4-address
in: path
description: IP address
required: true
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
put:
tags:
- CloudInfrastructure
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: create or update an existing l3-interface-ipv4-address-list
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Name given to the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: l3-interface-ipv4-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
+ description: l3-interface-ipv4-address-list object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Name given to the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: l3-interface-ipv4-address
in: path
description: IP address
required: true
description: resource-version for concurrency
required: true
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ 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: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ 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:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ 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: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ 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
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
get:
tags:
- CloudInfrastructure
- summary: returns l-interface
- description: returns l-interface
- operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
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: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
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:
- CloudInfrastructure
- summary: create or update an existing l-interface
- description: create or update an existing l-interface
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: create or update an existing l3-interface-ipv6-address-list
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
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: l-interface object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l-interface
- description: delete an existing l-interface
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
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
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}:
get:
tags:
- CloudInfrastructure
- summary: returns l-interfaces
- description: returns l-interfaces
- operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/definitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ 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: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - 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:
+ - CloudInfrastructure
+ summary: create or update an existing l-interface
+ description: create or update an existing l-interface
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ 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: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ 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:
+ - CloudInfrastructure
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ 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: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ 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
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
+ 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: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
- name: vserver-name
in: query
description: Name of vserver
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
put:
tags:
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Readable name of tenant
required: false
type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
put:
tags:
- CloudInfrastructure
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
- required: true
- type: string
- - name: cloud-region-id
- in: path
- description: Identifier used by the vendor for the region. Second part of composite key
- required: true
- type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
- get:
- tags:
- - CloudInfrastructure
- summary: returns cloud-region
- description: returns cloud-region
- operationId: getCloudInfrastructureCloudRegionsCloudRegion
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/cloud-region"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: cloud-owner
- in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
- required: false
- type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
- summary: create or update an existing cloud-region
- description: create or update an existing cloud-region
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
- name: body
in: body
- description: cloud-region object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/cloud-region"
+ $ref: "#/definitions/relationship"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing cloud-region
- description: delete an existing cloud-region
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
required: true
type: string
- /cloud-infrastructure/cloud-regions:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
get:
tags:
- CloudInfrastructure
- summary: returns cloud-regions
- description: returns cloud-regions
- operationId: getCloudInfrastructureCloudRegions
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/cloud-regions"
+ $ref: "#/definitions/esr-system-info"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: system-name
+ in: query
+ description: name of external system.
+ required: false
+ type: string
+ - name: system-type
+ in: query
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ required: false
+ type: string
put:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: nm-profile-name
+ - name: cloud-owner
in: path
- description: Unique name of network profile.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: esr-system-info object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/esr-system-info"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: nm-profile-name
+ - name: cloud-owner
in: path
- description: Unique name of network profile.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
get:
tags:
- CloudInfrastructure
- summary: returns network-profile
- description: returns network-profile
- operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/network-profile"
+ $ref: "#/definitions/esr-system-info-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: nm-profile-name
+ - name: cloud-owner
in: path
- description: Unique name of network profile.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
- summary: create or update an existing network-profile
- description: create or update an existing network-profile
- operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: nm-profile-name
+ - name: cloud-owner
in: path
- description: Unique name of network profile.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
required: true
type: string
- name: body
in: body
- description: network-profile object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/network-profile"
+ $ref: "#/definitions/relationship"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing network-profile
- description: delete an existing network-profile
- operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: nm-profile-name
+ - name: cloud-owner
in: path
- description: Unique name of network profile.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- /cloud-infrastructure/network-profiles:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
get:
tags:
- CloudInfrastructure
- summary: returns network-profiles
- description: returns network-profiles
- operationId: getCloudInfrastructureNetworkProfiles
+ summary: returns vip-ipv4-address-list
+ description: returns vip-ipv4-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/network-profiles"
+ $ref: "#/definitions/vip-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ 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:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
+ summary: create or update an existing vip-ipv4-address-list
+ description: create or update an existing vip-ipv4-address-list
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: vip-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
+ description: vip-ipv4-address-list object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/vip-ipv4-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
+ summary: delete an existing vip-ipv4-address-list
+ description: delete an existing vip-ipv4-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: vip-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
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- - name: interface-name
+ - name: cloud-region-id
in: path
- description: Name that identifies the physical interface
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
required: true
type: string
- name: body
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- - name: interface-name
+ - name: cloud-region-id
in: path
- description: Name that identifies the physical interface
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
- put:
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
+ get:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns vip-ipv6-address-list
+ description: returns vip-ipv6-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vip-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- - name: interface-name
+ - name: cloud-region-id
in: path
- description: Name that identifies the physical interface
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ 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:
+ - CloudInfrastructure
+ summary: create or update an existing vip-ipv6-address-list
+ description: create or update an existing vip-ipv6-address-list
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ 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: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: vip-ipv6-address-list object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/vip-ipv6-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing vip-ipv6-address-list
+ description: delete an existing vip-ipv6-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ 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: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: vip-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
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns cloud-region
+ description: returns cloud-region
+ operationId: getCloudInfrastructureCloudRegionsCloudRegion
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/cloud-region"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing cloud-region
+ description: create or update an existing cloud-region
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
+ 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: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: cloud-region object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/cloud-region"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing cloud-region
+ description: delete an existing cloud-region
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
+ 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: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns cloud-regions
+ description: returns cloud-regions
+ operationId: getCloudInfrastructureCloudRegions
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/cloud-regions"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
+ 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: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ 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:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
+ 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: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns network-profile
+ description: returns network-profile
+ operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/network-profile"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing network-profile
+ description: create or update an existing network-profile
+ operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
+ 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: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: network-profile object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/network-profile"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing network-profile
+ description: delete an existing network-profile
+ operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
+ 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: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/network-profiles:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns network-profiles
+ description: returns network-profiles
+ operationId: getCloudInfrastructureNetworkProfiles
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/network-profiles"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
+ 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: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ 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:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
+ 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: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
+ 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: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical 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:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
+ 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: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ 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: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
required: true
type: string
- name: pf-pci-id
$ref: "#/definitions/virtual-data-centers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /license-management/license-key-resources/license-key-resource/{att-uuid}/relationship-list/relationship:
+ /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
put:
tags:
- - LicenseManagement
+ - ExternalSystem
summary: see node definition for valid relationships
- operationId: createOrUpdateLicenseManagementLicenseKeyResourcesLicenseKeyResourceRelationshipListRelationship
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: ems-id
in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - LicenseManagement
+ - ExternalSystem
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteLicenseManagementLicenseKeyResourcesLicenseKeyResourceRelationshipListRelationship
+ operationId: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- /license-management/license-key-resources/license-key-resource/{att-uuid}:
+ /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
get:
tags:
- - LicenseManagement
- summary: returns license-key-resource
- description: returns license-key-resource
- operationId: getLicenseManagementLicenseKeyResourcesLicenseKeyResource
+ - ExternalSystem
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/license-key-resource"
+ $ref: "#/definitions/esr-system-info"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- - name: assignment-group-uuid
+ - name: system-name
in: query
+ description: name of external system.
required: false
type: string
- - name: name
+ - name: system-type
in: query
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
required: false
type: string
put:
tags:
- - LicenseManagement
- summary: create or update an existing license-key-resource
- description: create or update an existing license-key-resource
- operationId: createOrUpdateLicenseManagementLicenseKeyResourcesLicenseKeyResource
+ - ExternalSystem
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
in: body
- description: license-key-resource object that needs to be created or updated
+ description: esr-system-info object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/license-key-resource"
+ $ref: "#/definitions/esr-system-info"
delete:
tags:
- - LicenseManagement
- summary: delete an existing license-key-resource
- description: delete an existing license-key-resource
- operationId: deleteLicenseManagementLicenseKeyResourcesLicenseKeyResource
+ - ExternalSystem
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: ems-id
in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /license-management/license-key-resources:
+ /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list:
get:
tags:
- - LicenseManagement
- summary: returns license-key-resources
- description: returns license-key-resources
- operationId: getLicenseManagementLicenseKeyResources
+ - ExternalSystem
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/license-key-resources"
+ $ref: "#/definitions/esr-system-info-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship:
put:
tags:
- - Business
+ - ExternalSystem
summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: ems-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of EMS.
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - Business
+ - ExternalSystem
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
+ operationId: deleteExternalSystemEsrEmsListEsrEmsRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: ems-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of EMS.
required: true
type: string
- /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
+ /external-system/esr-ems-list/esr-ems/{ems-id}:
get:
tags:
- - Business
- summary: returns metadatum
- description: returns metadatum
- operationId: getBusinessConnectorsConnectorMetadataMetadatum
+ - ExternalSystem
+ summary: returns esr-ems
+ description: returns esr-ems
+ operationId: getExternalSystemEsrEmsListEsrEms
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/esr-ems"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
- in: path
- description: Unique id of resource instance.
- required: true
- type: string
- - name: metaname
+ - name: ems-id
in: path
+ description: Unique ID of EMS.
required: true
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- 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:
- - Business
- summary: create or update an existing metadatum
- description: create or update an existing metadatum
- operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
+ - ExternalSystem
+ summary: create or update an existing esr-ems
+ description: create or update an existing esr-ems
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEms
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
- in: path
- description: Unique id of resource instance.
- required: true
- type: string
- - name: metaname
+ - name: ems-id
in: path
+ description: Unique ID of EMS.
required: true
type: string
- name: body
in: body
- description: metadatum object that needs to be created or updated
+ description: esr-ems object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/esr-ems"
delete:
tags:
- - Business
- summary: delete an existing metadatum
- description: delete an existing metadatum
- operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
+ - ExternalSystem
+ summary: delete an existing esr-ems
+ description: delete an existing esr-ems
+ operationId: deleteExternalSystemEsrEmsListEsrEms
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
- in: path
- description: Unique id of resource instance.
- required: true
- type: string
- - name: metaname
+ - name: ems-id
in: path
+ description: Unique ID of EMS.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /business/connectors/connector/{resource-instance-id}/metadata:
+ /external-system/esr-ems-list:
get:
tags:
- - Business
- summary: returns metadata
- description: returns metadata
- operationId: getBusinessConnectorsConnectorMetadata
+ - ExternalSystem
+ summary: returns esr-ems-list
+ description: returns esr-ems-list
+ operationId: getExternalSystemEsrEmsList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadata"
+ $ref: "#/definitions/esr-ems-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ 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: resource-instance-id
+ - name: vnfm-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of VNFM.
required: true
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
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
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ 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: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
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
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
type: string
- /business/connectors/connector/{resource-instance-id}:
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
get:
tags:
- - Business
- summary: returns connector
- description: returns connector
- operationId: getBusinessConnectorsConnector
+ - ExternalSystem
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/connector"
+ $ref: "#/definitions/esr-system-info"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: vnfm-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of VNFM.
required: true
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
type: string
- - name: widget-model-id
+ - name: system-name
in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ description: name of external system.
required: false
type: string
- - name: widget-model-version
+ - name: system-type
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
required: false
type: string
put:
tags:
- - Business
- summary: create or update an existing connector
- description: create or update an existing connector
- operationId: createOrUpdateBusinessConnectorsConnector
+ - ExternalSystem
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: vnfm-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
in: body
- description: connector object that needs to be created or updated
+ description: esr-system-info object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/connector"
+ $ref: "#/definitions/esr-system-info"
delete:
tags:
- - Business
- summary: delete an existing connector
- description: delete an existing connector
- operationId: deleteBusinessConnectorsConnector
+ - ExternalSystem
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: vnfm-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /business/connectors:
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list:
get:
tags:
- - Business
- summary: returns connectors
- description: returns connectors
- operationId: getBusinessConnectors
+ - ExternalSystem
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/connectors"
+ $ref: "#/definitions/esr-system-info-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship:
put:
tags:
- - Business
+ - ExternalSystem
summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
+ - name: vnfm-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique ID of VNFM.
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - Business
+ - ExternalSystem
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
+ - name: vnfm-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique ID of VNFM.
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}:
get:
tags:
- - Business
- summary: returns metadatum
- description: returns metadatum
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ - ExternalSystem
+ summary: returns esr-vnfm
+ description: returns esr-vnfm
+ operationId: getExternalSystemEsrVnfmListEsrVnfm
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/esr-vnfm"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
+ - name: vnfm-id
in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
+ description: Unique ID of VNFM.
required: true
type: string
- - name: service-type
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-vnfm
+ description: create or update an existing esr-vnfm
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfm
+ 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: vnfm-id
in: path
- description: Value defined by orchestration to identify this service across ECOMP.
+ description: Unique ID of VNFM.
required: true
type: string
- - name: service-instance-id
- in: path
- description: Uniquely identifies this instance of a service
+ - name: body
+ in: body
+ description: esr-vnfm object that needs to be created or updated
required: true
- type: string
- - name: metaname
+ schema:
+ $ref: "#/definitions/esr-vnfm"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-vnfm
+ description: delete an existing esr-vnfm
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfm
+ 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: vnfm-id
in: path
+ description: Unique ID of VNFM.
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
- type: string
- - name: service-instance-name
- in: query
- description: This field will store a name assigned to the service-instance.
- required: false
- type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- 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: service-instance-location-id
- in: query
- description: An identifier that customers assign to the location where this service is being used.
- required: false
- type: string
- - name: orchestration-status
+ - name: resource-version
in: query
- description: Orchestration status of this service.
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
+ /external-system/esr-vnfm-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-vnfm-list
+ description: returns esr-vnfm-list
+ operationId: getExternalSystemEsrVnfmList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-vnfm-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
put:
tags:
- - Business
- summary: create or update an existing metadatum
- description: create or update an existing metadatum
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
+ - name: thirdparty-sdnc-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique ID of SDNC.
required: true
type: string
- - name: metaname
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
in: body
- description: metadatum object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/relationship"
delete:
tags:
- - Business
- summary: delete an existing metadatum
- description: delete an existing metadatum
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
+ - name: thirdparty-sdnc-id
in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
- in: path
- description: Uniquely identifies this instance of a service
+ description: Unique ID of SDNC.
required: true
type: string
- - name: metaname
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
get:
tags:
- - Business
- summary: returns metadata
- description: returns metadata
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
+ - ExternalSystem
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadata"
+ $ref: "#/definitions/esr-system-info"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
+ - name: thirdparty-sdnc-id
in: path
- description: Value defined by orchestration to identify this service across ECOMP.
+ description: Unique ID of SDNC.
required: true
type: string
- - name: service-instance-id
+ - name: esr-system-info-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique ID of esr system info.
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
- type: string
- - name: service-instance-name
- in: query
- description: This field will store a name assigned to the service-instance.
- required: false
- type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- 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: service-instance-location-id
+ - name: system-name
in: query
- description: An identifier that customers assign to the location where this service is being used.
+ description: name of external system.
required: false
type: string
- - name: orchestration-status
+ - name: system-type
in: query
- description: Orchestration status of this service.
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
required: false
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
put:
tags:
- - Business
- summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
+ - ExternalSystem
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
- in: path
- description: Uniquely identifies this instance of a service
- required: true
- type: string
- - name: id
+ - name: thirdparty-sdnc-id
in: path
- description: Allotted Resource id UUID assigned to this instance.
+ description: Unique ID of SDNC.
required: true
type: string
- - name: id
+ - name: esr-system-info-id
in: path
- description: Allotted Resource id UUID assigned to this instance.
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: esr-system-info object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/esr-system-info"
delete:
tags:
- - Business
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
+ - ExternalSystem
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
+ - name: thirdparty-sdnc-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique ID of SDNC.
required: true
type: string
- - name: id
+ - name: esr-system-info-id
in: path
- description: Allotted Resource id UUID assigned to this instance.
+ description: Unique ID of esr system info.
required: true
type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list:
get:
tags:
- - Business
- summary: returns tunnel-xconnect
- description: returns tunnel-xconnect
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ - ExternalSystem
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/tunnel-xconnect"
+ $ref: "#/definitions/esr-system-info-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
+ - name: thirdparty-sdnc-id
in: path
- description: Value defined by orchestration to identify this service across ECOMP.
+ description: Unique ID of SDNC.
required: true
type: string
- - name: service-instance-id
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship
+ 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: thirdparty-sdnc-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique ID of SDNC.
required: true
type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
required: true
- type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship
+ 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: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-thirdparty-sdnc
+ description: returns esr-thirdparty-sdnc
+ operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
type: string
- - name: service-instance-name
- in: query
- description: This field will store a name assigned to the service-instance.
- required: false
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-thirdparty-sdnc
+ description: create or update an existing esr-thirdparty-sdnc
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ 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: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
+ - name: body
+ in: body
+ description: esr-thirdparty-sdnc object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-thirdparty-sdnc
+ description: delete an existing esr-thirdparty-sdnc
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ 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: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
type: string
- - name: model-version-id
+ - name: resource-version
in: query
- description: the ASDC model version for this resource or service model.
- required: false
+ description: resource-version for concurrency
+ required: true
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
+ /external-system/esr-thirdparty-sdnc-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-thirdparty-sdnc-list
+ description: returns esr-thirdparty-sdnc-list
+ operationId: getExternalSystemEsrThirdpartySdncList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-thirdparty-sdnc-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
+ 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: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
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
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
+ 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: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
type: string
- - name: service-instance-location-id
- in: query
- description: An identifier that customers assign to the location where this service is being used.
- required: false
+ /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - Business
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getBusinessConnectorsConnectorMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
type: string
- - name: orchestration-status
- in: query
- description: Orchestration status of this service.
- required: false
+ - name: metaname
+ in: path
+ required: true
type: string
- name: model-invariant-id
in: query
description: the ASDC model version for this resource or service model.
required: false
type: string
- - name: type
+ - name: widget-model-id
in: query
- description: Generic description of the type of allotted resource.
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
required: false
type: string
- - name: role
+ - name: widget-model-version
in: query
- description: role in the network that this resource will be providing.
+ 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:
- Business
- summary: create or update an existing tunnel-xconnect
- description: create or update an existing tunnel-xconnect
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ summary: create or update an existing metadatum
+ description: create or update an existing metadatum
+ operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
- in: path
- description: Uniquely identifies this instance of a service
- required: true
- type: string
- - name: id
+ - name: resource-instance-id
in: path
- description: Allotted Resource id UUID assigned to this instance.
+ description: Unique id of resource instance.
required: true
type: string
- - name: id
+ - name: metaname
in: path
- description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- name: body
in: body
- description: tunnel-xconnect object that needs to be created or updated
+ description: metadatum object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/tunnel-xconnect"
+ $ref: "#/definitions/metadatum"
delete:
tags:
- Business
- summary: delete an existing tunnel-xconnect
- description: delete an existing tunnel-xconnect
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
- in: path
- description: Uniquely identifies this instance of a service
- required: true
- type: string
- - name: id
+ - name: resource-instance-id
in: path
- description: Allotted Resource id UUID assigned to this instance.
+ description: Unique id of resource instance.
required: true
type: string
- - name: id
+ - name: metaname
in: path
- description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
+ /business/connectors/connector/{resource-instance-id}/metadata:
get:
tags:
- Business
- summary: returns tunnel-xconnects
- description: returns tunnel-xconnects
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
+ summary: returns metadata
+ description: returns metadata
+ operationId: getBusinessConnectorsConnectorMetadata
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/tunnel-xconnects"
+ $ref: "#/definitions/metadata"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
- in: path
- description: Uniquely identifies this instance of a service
- required: true
- type: string
- - name: id
+ - name: resource-instance-id
in: path
- description: Allotted Resource id UUID assigned to this instance.
+ description: Unique id of resource instance.
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
- type: string
- - name: service-instance-name
- in: query
- description: This field will store a name assigned to the service-instance.
- required: false
- type: string
- name: model-invariant-id
in: query
description: the ASDC model id for this resource or service model.
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: service-instance-location-id
- in: query
- description: An identifier that customers assign to the location where this service is being used.
- required: false
- type: string
- - name: orchestration-status
- in: query
- description: Orchestration status of this service.
- required: false
+ /business/connectors/connector/{resource-instance-id}:
+ get:
+ tags:
+ - Business
+ summary: returns connector
+ description: returns connector
+ operationId: getBusinessConnectorsConnector
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/connector"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
type: string
- name: model-invariant-id
in: query
description: the ASDC model version for this resource or service model.
required: false
type: string
- - name: type
+ - name: widget-model-id
in: query
- description: Generic description of the type of allotted resource.
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
required: false
type: string
- - name: role
+ - name: widget-model-version
in: query
- description: role in the network that this resource will be providing.
+ 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
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: create or update an existing connector
+ description: create or update an existing connector
+ operationId: createOrUpdateBusinessConnectorsConnector
+ 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: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: connector object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/connector"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing connector
+ description: delete an existing connector
+ operationId: deleteBusinessConnectorsConnector
+ 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: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/connectors:
+ get:
+ tags:
+ - Business
+ summary: returns connectors
+ description: returns connectors
+ operationId: getBusinessConnectors
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/connectors"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
put:
tags:
- Business
summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- required: true
- type: string
- name: body
in: body
description: relationship object that needs to be created or updated
- Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- required: true
- type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
get:
tags:
- Business
- summary: returns allotted-resource
- description: returns allotted-resource
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/allotted-resource"
+ $ref: "#/definitions/metadatum"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
+ - name: metaname
in: path
- description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- name: subscriber-name
description: This field will store a name assigned to the service-instance.
required: false
type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
- name: model-invariant-id
in: query
description: the ASDC model id for this resource or service model.
description: Orchestration status of this service.
required: false
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: type
- in: query
- description: Generic description of the type of allotted resource.
- required: false
- type: string
- - name: role
- in: query
- description: role in the network that this resource will be providing.
- required: false
- type: string
put:
tags:
- Business
- summary: create or update an existing allotted-resource
- description: create or update an existing allotted-resource
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ summary: create or update an existing metadatum
+ description: create or update an existing metadatum
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
consumes:
- application/json
- application/xml
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
+ - name: metaname
in: path
- description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- name: body
in: body
- description: allotted-resource object that needs to be created or updated
+ description: metadatum object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/allotted-resource"
+ $ref: "#/definitions/metadatum"
delete:
tags:
- Business
- summary: delete an existing allotted-resource
- description: delete an existing allotted-resource
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
consumes:
- application/json
- application/xml
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
+ - name: metaname
in: path
- description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
get:
tags:
- Business
- summary: returns allotted-resources
- description: returns allotted-resources
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
+ summary: returns metadata
+ description: returns metadata
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/allotted-resources"
+ $ref: "#/definitions/metadata"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: This field will store a name assigned to the service-instance.
required: false
type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
- name: model-invariant-id
in: query
description: the ASDC model id for this resource or service model.
description: Orchestration status of this service.
required: false
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
- get:
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
+ put:
tags:
- Business
- summary: returns service-instance
- description: returns service-instance
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ 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:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
+ 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: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
+ get:
+ tags:
+ - Business
+ summary: returns tunnel-xconnect
+ description: returns tunnel-xconnect
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
description: successful operation
schema:
- $ref: "#/definitions/service-instance"
+ $ref: "#/definitions/tunnel-xconnect"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Uniquely identifies this instance of a service
required: true
type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
description: This field will store a name assigned to the service-instance.
required: false
type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
- name: model-invariant-id
in: query
description: the ASDC model id for this resource or service model.
description: Orchestration status of this service.
required: false
type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: type
+ in: query
+ description: Generic description of the type of allotted resource.
+ required: false
+ type: string
+ - name: role
+ in: query
+ description: role in the network that this resource will be providing.
+ required: false
+ type: string
put:
tags:
- Business
- summary: create or update an existing service-instance
- description: create or update an existing service-instance
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
+ summary: create or update an existing tunnel-xconnect
+ description: create or update an existing tunnel-xconnect
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
consumes:
- application/json
- application/xml
description: Uniquely identifies this instance of a service
required: true
type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: body
in: body
- description: service-instance object that needs to be created or updated
+ description: tunnel-xconnect object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/service-instance"
+ $ref: "#/definitions/tunnel-xconnect"
delete:
tags:
- Business
- summary: delete an existing service-instance
- description: delete an existing service-instance
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
+ summary: delete an existing tunnel-xconnect
+ description: delete an existing tunnel-xconnect
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
consumes:
- application/json
- application/xml
description: Uniquely identifies this instance of a service
required: true
type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: resource-version
in: query
description: resource-version for concurrency
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
get:
tags:
- Business
- summary: returns service-instances
- description: returns service-instances
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
+ summary: returns tunnel-xconnects
+ description: returns tunnel-xconnects
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-instances"
+ $ref: "#/definitions/tunnel-xconnects"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
description: Subscriber type, a way to provide VID with only the INFRA customers.
required: false
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ 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: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: type
+ in: query
+ description: Generic description of the type of allotted resource.
+ required: false
+ type: string
+ - name: role
+ in: query
+ description: role in the network that this resource will be providing.
+ required: false
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
put:
tags:
- Business
summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: body
in: body
description: relationship object that needs to be created or updated
- Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
get:
tags:
- Business
- summary: returns service-subscription
- description: returns service-subscription
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
+ summary: returns allotted-resource
+ description: returns allotted-resource
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-subscription"
+ $ref: "#/definitions/allotted-resource"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
description: Subscriber type, a way to provide VID with only the INFRA customers.
required: false
type: string
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ 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: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: type
+ in: query
+ description: Generic description of the type of allotted resource.
+ required: false
+ type: string
+ - name: role
+ in: query
+ description: role in the network that this resource will be providing.
+ required: false
+ type: string
put:
tags:
- Business
- summary: create or update an existing service-subscription
- description: create or update an existing service-subscription
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
+ summary: create or update an existing allotted-resource
+ description: create or update an existing allotted-resource
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
consumes:
- application/json
- application/xml
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: body
in: body
- description: service-subscription object that needs to be created or updated
+ description: allotted-resource object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/service-subscription"
+ $ref: "#/definitions/allotted-resource"
delete:
tags:
- Business
- summary: delete an existing service-subscription
- description: delete an existing service-subscription
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
+ summary: delete an existing allotted-resource
+ description: delete an existing allotted-resource
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
consumes:
- application/json
- application/xml
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: resource-version
in: query
description: resource-version for concurrency
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions:
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
get:
tags:
- Business
- summary: returns service-subscriptions
- description: returns service-subscriptions
- operationId: getBusinessCustomersCustomerServiceSubscriptions
+ summary: returns allotted-resources
+ description: returns allotted-resources
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-subscriptions"
+ $ref: "#/definitions/allotted-resources"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
description: Subscriber type, a way to provide VID with only the INFRA customers.
required: false
type: string
- /business/customers/customer/{global-customer-id}/relationship-list/relationship:
- put:
- tags:
- - Business
- summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
- 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: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Business
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
- 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: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
type: string
- /business/customers/customer/{global-customer-id}:
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ 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: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
get:
tags:
- Business
- summary: returns customer
- description: returns customer
- operationId: getBusinessCustomersCustomer
+ summary: returns service-instance
+ description: returns service-instance
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/customer"
+ $ref: "#/definitions/service-instance"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
description: Subscriber type, a way to provide VID with only the INFRA customers.
required: false
type: string
- put:
- tags:
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ 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: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ put:
+ tags:
- Business
- summary: create or update an existing customer
- description: create or update an existing customer
- operationId: createOrUpdateBusinessCustomersCustomer
+ summary: create or update an existing service-instance
+ description: create or update an existing service-instance
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
consumes:
- application/json
- application/xml
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
- name: body
in: body
- description: customer object that needs to be created or updated
+ description: service-instance object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/customer"
+ $ref: "#/definitions/service-instance"
delete:
tags:
- Business
- summary: delete an existing customer
- description: delete an existing customer
- operationId: deleteBusinessCustomersCustomer
+ summary: delete an existing service-instance
+ description: delete an existing service-instance
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
consumes:
- application/json
- application/xml
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
- name: resource-version
in: query
description: resource-version for concurrency
required: true
type: string
- /business/customers:
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
get:
tags:
- Business
- summary: returns customers
- description: returns customers
- operationId: getBusinessCustomers
+ summary: returns service-instances
+ description: returns service-instances
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/customers"
+ $ref: "#/definitions/service-instances"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /service-design-and-creation/vnf-images/vnf-image/{att-uuid}/relationship-list/relationship:
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
put:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: global-customer-id
in: path
- description: Unique ID of this asset
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: global-customer-id
in: path
- description: Unique ID of this asset
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
- /service-design-and-creation/vnf-images/vnf-image/{att-uuid}:
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns vnf-image
- description: returns vnf-image
- operationId: getServiceDesignAndCreationVnfImagesVnfImage
+ - Business
+ summary: returns service-subscription
+ description: returns service-subscription
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vnf-image"
+ $ref: "#/definitions/service-subscription"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: global-customer-id
in: path
- description: Unique ID of this asset
+ description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
type: string
- - name: application-vendor
+ - name: subscriber-name
in: query
- description: The vendor of the application.
+ description: Subscriber name, an alternate way to retrieve a customer.
required: false
type: string
- - name: application-version
+ - name: subscriber-type
in: query
- description: The version of the application.
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
required: false
type: string
put:
tags:
- - ServiceDesignAndCreation
- summary: create or update an existing vnf-image
- description: create or update an existing vnf-image
- operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
+ - Business
+ summary: create or update an existing service-subscription
+ description: create or update an existing service-subscription
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: global-customer-id
in: path
- description: Unique ID of this asset
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
- name: body
in: body
- description: vnf-image object that needs to be created or updated
+ description: service-subscription object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/vnf-image"
+ $ref: "#/definitions/service-subscription"
delete:
tags:
- - ServiceDesignAndCreation
- summary: delete an existing vnf-image
- description: delete an existing vnf-image
- operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
+ - Business
+ summary: delete an existing service-subscription
+ description: delete an existing service-subscription
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: global-customer-id
in: path
- description: Unique ID of this asset
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/vnf-images:
+ /business/customers/customer/{global-customer-id}/service-subscriptions:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns vnf-images
- description: returns vnf-images
- operationId: getServiceDesignAndCreationVnfImages
+ - Business
+ summary: returns service-subscriptions
+ description: returns service-subscriptions
+ operationId: getBusinessCustomersCustomerServiceSubscriptions
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vnf-images"
+ $ref: "#/definitions/service-subscriptions"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ /business/customers/customer/{global-customer-id}/relationship-list/relationship:
put:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
+ operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-id
+ - name: global-customer-id
in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
+ operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-id
+ - name: global-customer-id
in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
- /service-design-and-creation/services/service/{service-id}:
+ /business/customers/customer/{global-customer-id}:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns service
- description: returns service
- operationId: getServiceDesignAndCreationServicesService
+ - Business
+ summary: returns customer
+ description: returns customer
+ operationId: getBusinessCustomersCustomer
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/service"
+ $ref: "#/definitions/customer"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-id
+ - name: global-customer-id
in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
- - name: service-description
+ - name: subscriber-name
in: query
- description: Description of the service
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
required: false
type: string
put:
tags:
- - ServiceDesignAndCreation
- summary: create or update an existing service
- description: create or update an existing service
- operationId: createOrUpdateServiceDesignAndCreationServicesService
+ - Business
+ summary: create or update an existing customer
+ description: create or update an existing customer
+ operationId: createOrUpdateBusinessCustomersCustomer
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-id
+ - name: global-customer-id
in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
- name: body
in: body
- description: service object that needs to be created or updated
+ description: customer object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/service"
+ $ref: "#/definitions/customer"
delete:
tags:
- - ServiceDesignAndCreation
- summary: delete an existing service
- description: delete an existing service
- operationId: deleteServiceDesignAndCreationServicesService
+ - Business
+ summary: delete an existing customer
+ description: delete an existing customer
+ operationId: deleteBusinessCustomersCustomer
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-id
+ - name: global-customer-id
in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/services:
+ /business/customers:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns services
- description: returns services
- operationId: getServiceDesignAndCreationServices
+ - Business
+ summary: returns customers
+ description: returns customers
+ operationId: getBusinessCustomers
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/services"
+ $ref: "#/definitions/customers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
+ /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
put:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
+ operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-type
- in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
- required: true
- type: string
- - name: vnf-type
+ - name: line-of-business-name
in: path
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ description: Name of the line-of-business (product)
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
+ operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-type
- in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
- required: true
- type: string
- - name: vnf-type
+ - name: line-of-business-name
in: path
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ description: Name of the line-of-business (product)
required: true
type: string
- /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
+ /business/lines-of-business/line-of-business/{line-of-business-name}:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns service-capability
- description: returns service-capability
- operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ - Business
+ summary: returns line-of-business
+ description: returns line-of-business
+ operationId: getBusinessLinesOfBusinessLineOfBusiness
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-capability"
+ $ref: "#/definitions/line-of-business"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-type
- in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
- required: true
- type: string
- - name: vnf-type
+ - name: line-of-business-name
in: path
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ description: Name of the line-of-business (product)
required: true
type: string
put:
tags:
- - ServiceDesignAndCreation
- summary: create or update an existing service-capability
- description: create or update an existing service-capability
- operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ - Business
+ summary: create or update an existing line-of-business
+ description: create or update an existing line-of-business
+ operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-type
- in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
- required: true
- type: string
- - name: vnf-type
+ - name: line-of-business-name
in: path
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ description: Name of the line-of-business (product)
required: true
type: string
- name: body
in: body
- description: service-capability object that needs to be created or updated
+ description: line-of-business object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/service-capability"
+ $ref: "#/definitions/line-of-business"
delete:
tags:
- - ServiceDesignAndCreation
- summary: delete an existing service-capability
- description: delete an existing service-capability
- operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ - Business
+ summary: delete an existing line-of-business
+ description: delete an existing line-of-business
+ operationId: deleteBusinessLinesOfBusinessLineOfBusiness
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-type
- in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
- required: true
- type: string
- - name: vnf-type
+ - name: line-of-business-name
in: path
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ description: Name of the line-of-business (product)
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/service-capabilities:
+ /business/lines-of-business:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns service-capabilities
- description: returns service-capabilities
- operationId: getServiceDesignAndCreationServiceCapabilities
+ - Business
+ summary: returns lines-of-business
+ description: returns lines-of-business
+ operationId: getBusinessLinesOfBusiness
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-capabilities"
+ $ref: "#/definitions/lines-of-business"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
+ /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
put:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
+ operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: element-choice-set-uuid
+ - name: owning-entity-id
in: path
+ description: UUID of an owning entity
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
+ operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: element-choice-set-uuid
+ - name: owning-entity-id
in: path
+ description: UUID of an owning entity
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
+ /business/owning-entities/owning-entity/{owning-entity-id}:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns element-choice-set
- description: returns element-choice-set
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ - Business
+ summary: returns owning-entity
+ description: returns owning-entity
+ operationId: getBusinessOwningEntitiesOwningEntity
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/element-choice-set"
+ $ref: "#/definitions/owning-entity"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: element-choice-set-uuid
+ - name: owning-entity-id
in: path
+ description: UUID of an owning entity
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
put:
tags:
- - ServiceDesignAndCreation
- summary: create or update an existing element-choice-set
- description: create or update an existing element-choice-set
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ - Business
+ summary: create or update an existing owning-entity
+ description: create or update an existing owning-entity
+ operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: element-choice-set-uuid
+ - name: owning-entity-id
in: path
+ description: UUID of an owning entity
required: true
type: string
- name: body
in: body
- description: element-choice-set object that needs to be created or updated
+ description: owning-entity object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/element-choice-set"
+ $ref: "#/definitions/owning-entity"
delete:
tags:
- - ServiceDesignAndCreation
- summary: delete an existing element-choice-set
- description: delete an existing element-choice-set
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ - Business
+ summary: delete an existing owning-entity
+ description: delete an existing owning-entity
+ operationId: deleteBusinessOwningEntitiesOwningEntity
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: element-choice-set-uuid
+ - name: owning-entity-id
in: path
+ description: UUID of an owning entity
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
+ /business/owning-entities:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns element-choice-sets
- description: returns element-choice-sets
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
+ - Business
+ summary: returns owning-entities
+ description: returns owning-entities
+ operationId: getBusinessOwningEntities
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/element-choice-sets"
+ $ref: "#/definitions/owning-entities"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
+ /business/platforms/platform/{platform-name}/relationship-list/relationship:
put:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
+ operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
+ - name: platform-name
in: path
+ description: Name of the platform
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
+ operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
+ - name: platform-name
in: path
+ description: Name of the platform
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
+ /business/platforms/platform/{platform-name}:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns constrained-element-set
- description: returns constrained-element-set
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ - Business
+ summary: returns platform
+ description: returns platform
+ operationId: getBusinessPlatformsPlatform
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/constrained-element-set"
+ $ref: "#/definitions/platform"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
+ - name: platform-name
in: path
+ description: Name of the platform
required: true
type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
put:
tags:
- - ServiceDesignAndCreation
- summary: create or update an existing constrained-element-set
- description: create or update an existing constrained-element-set
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ - Business
+ summary: create or update an existing platform
+ description: create or update an existing platform
+ operationId: createOrUpdateBusinessPlatformsPlatform
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
+ - name: platform-name
in: path
+ description: Name of the platform
required: true
type: string
- name: body
in: body
- description: constrained-element-set object that needs to be created or updated
+ description: platform object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/constrained-element-set"
+ $ref: "#/definitions/platform"
delete:
tags:
- - ServiceDesignAndCreation
- summary: delete an existing constrained-element-set
- description: delete an existing constrained-element-set
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ - Business
+ summary: delete an existing platform
+ description: delete an existing platform
+ operationId: deleteBusinessPlatformsPlatform
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
+ - name: platform-name
in: path
+ description: Name of the platform
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
+ /business/platforms:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns constrained-element-sets
- description: returns constrained-element-sets
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
+ - Business
+ summary: returns platforms
+ description: returns platforms
+ operationId: getBusinessPlatforms
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/constrained-element-sets"
+ $ref: "#/definitions/platforms"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/projects/project/{project-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
+ 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: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
+ - name: project-name
in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ description: Name of the project deploying a service
required: true
type: string
- - name: model-element-uuid
- in: path
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
required: true
- type: string
- - name: model-constraint-uuid
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessProjectsProjectRelationshipListRelationship
+ 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: project-name
in: path
+ description: Name of the project deploying a service
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
+ /business/projects/project/{project-name}:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns model-constraint
- description: returns model-constraint
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ - Business
+ summary: returns project
+ description: returns project
+ operationId: getBusinessProjectsProject
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-constraint"
+ $ref: "#/definitions/project"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
+ - name: project-name
in: path
+ description: Name of the project deploying a service
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
put:
tags:
- - ServiceDesignAndCreation
- summary: create or update an existing model-constraint
- description: create or update an existing model-constraint
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ - Business
+ summary: create or update an existing project
+ description: create or update an existing project
+ operationId: createOrUpdateBusinessProjectsProject
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
+ - name: project-name
in: path
+ description: Name of the project deploying a service
required: true
type: string
- name: body
in: body
- description: model-constraint object that needs to be created or updated
+ description: project object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/model-constraint"
+ $ref: "#/definitions/project"
delete:
tags:
- - ServiceDesignAndCreation
- summary: delete an existing model-constraint
- description: delete an existing model-constraint
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ - Business
+ summary: delete an existing project
+ description: delete an existing project
+ operationId: deleteBusinessProjectsProject
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
+ - name: project-name
in: path
+ description: Name of the project deploying a service
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
+ /business/projects:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns model-constraints
- description: returns model-constraints
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
+ - Business
+ summary: returns projects
+ description: returns projects
+ operationId: getBusinessProjects
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-constraints"
+ $ref: "#/definitions/projects"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
+ /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
put:
tags:
- ServiceDesignAndCreation
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
+ operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
+ - name: vnf-image-uuid
in: path
+ description: Unique ID of this asset
required: true
type: string
- name: body
- ServiceDesignAndCreation
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
+ operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
+ - name: vnf-image-uuid
in: path
+ description: Unique ID of this asset
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
+ /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
get:
tags:
- ServiceDesignAndCreation
- summary: returns model-element
- description: returns model-element
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
+ summary: returns vnf-image
+ description: returns vnf-image
+ operationId: getServiceDesignAndCreationVnfImagesVnfImage
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-element"
+ $ref: "#/definitions/vnf-image"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
+ - name: vnf-image-uuid
in: path
+ description: Unique ID of this asset
required: true
type: string
- - name: model-type
+ - name: application
in: query
- description: Type of the model, e.g., service, resource, widget, etc.
+ description: The application that the image instantiates.
required: false
type: string
- - name: model-name
+ - name: application-vendor
in: query
- description: Name of the model, which can change from version to version.
+ description: The vendor of the application.
required: false
type: string
- - name: model-version
+ - name: application-version
in: query
- description: Version
+ description: The version of the application.
required: false
type: string
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing model-element
- description: create or update an existing model-element
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
+ summary: create or update an existing vnf-image
+ description: create or update an existing vnf-image
+ operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
+ - name: vnf-image-uuid
in: path
+ description: Unique ID of this asset
required: true
type: string
- name: body
in: body
- description: model-element object that needs to be created or updated
+ description: vnf-image object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/model-element"
+ $ref: "#/definitions/vnf-image"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing model-element
- description: delete an existing model-element
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
+ summary: delete an existing vnf-image
+ description: delete an existing vnf-image
+ operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
+ - name: vnf-image-uuid
in: path
+ description: Unique ID of this asset
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
+ /service-design-and-creation/vnf-images:
get:
tags:
- ServiceDesignAndCreation
- summary: returns model-elements
- description: returns model-elements
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
+ summary: returns vnf-images
+ description: returns vnf-images
+ operationId: getServiceDesignAndCreationVnfImages
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-elements"
+ $ref: "#/definitions/vnf-images"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
- get:
+ /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
+ put:
tags:
- ServiceDesignAndCreation
- summary: returns metadatum
- description: returns metadatum
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/metadatum"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
+ - name: service-id
in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-version-id
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
+ 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: service-id
in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: metaname
+ /service-design-and-creation/services/service/{service-id}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns service
+ description: returns service
+ operationId: getServiceDesignAndCreationServicesService
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/service"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
+ - name: service-description
in: query
- description: Version
+ description: Description of the service
required: false
type: string
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing metadatum
- description: create or update an existing metadatum
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ summary: create or update an existing service
+ description: create or update an existing service
+ operationId: createOrUpdateServiceDesignAndCreationServicesService
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: metaname
+ - name: service-id
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- name: body
in: body
- description: metadatum object that needs to be created or updated
+ description: service object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/service"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing metadatum
- description: delete an existing metadatum
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ summary: delete an existing service
+ description: delete an existing service
+ operationId: deleteServiceDesignAndCreationServicesService
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: metaname
+ - name: service-id
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
+ /service-design-and-creation/services:
get:
tags:
- ServiceDesignAndCreation
- summary: returns metadata
- description: returns metadata
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
+ summary: returns services
+ description: returns services
+ operationId: getServiceDesignAndCreationServices
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadata"
+ $ref: "#/definitions/services"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
+ /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
put:
tags:
- ServiceDesignAndCreation
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
+ operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
+ - name: service-type
in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-version-id
+ - name: vnf-type
in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
required: true
type: string
- name: body
- ServiceDesignAndCreation
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
+ operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
+ - name: service-type
in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-version-id
+ - name: vnf-type
in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
+ /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
get:
tags:
- ServiceDesignAndCreation
- summary: returns model-ver
- description: returns model-ver
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
+ summary: returns service-capability
+ description: returns service-capability
+ operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-ver"
+ $ref: "#/definitions/service-capability"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
+ - name: service-type
in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-version-id
+ - name: vnf-type
in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing model-ver
- description: create or update an existing model-ver
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
+ summary: create or update an existing service-capability
+ description: create or update an existing service-capability
+ operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
+ - name: service-type
in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-version-id
+ - name: vnf-type
in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
required: true
type: string
- name: body
in: body
- description: model-ver object that needs to be created or updated
+ description: service-capability object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/model-ver"
+ $ref: "#/definitions/service-capability"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing model-ver
- description: delete an existing model-ver
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
+ summary: delete an existing service-capability
+ description: delete an existing service-capability
+ operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
+ - name: service-type
in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-version-id
+ - name: vnf-type
in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
+ /service-design-and-creation/service-capabilities:
get:
tags:
- ServiceDesignAndCreation
- summary: returns model-vers
- description: returns model-vers
- operationId: getServiceDesignAndCreationModelsModelModelVers
+ summary: returns service-capabilities
+ description: returns service-capabilities
+ operationId: getServiceDesignAndCreationServiceCapabilities
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-vers"
+ $ref: "#/definitions/service-capabilities"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
put:
tags:
- ServiceDesignAndCreation
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
- name: body
in: body
description: relationship object that needs to be created or updated
- ServiceDesignAndCreation
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}:
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
get:
tags:
- ServiceDesignAndCreation
- summary: returns model
- description: returns model
- operationId: getServiceDesignAndCreationModelsModel
+ summary: returns element-choice-set
+ description: returns element-choice-set
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model"
+ $ref: "#/definitions/element-choice-set"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
required: false
type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing model
- description: create or update an existing model
- operationId: createOrUpdateServiceDesignAndCreationModelsModel
+ summary: create or update an existing element-choice-set
+ description: create or update an existing element-choice-set
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
- name: body
in: body
- description: model object that needs to be created or updated
+ description: element-choice-set object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/model"
+ $ref: "#/definitions/element-choice-set"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing model
- description: delete an existing model
- operationId: deleteServiceDesignAndCreationModelsModel
+ summary: delete an existing element-choice-set
+ description: delete an existing element-choice-set
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
- name: resource-version
in: query
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/models:
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
get:
tags:
- ServiceDesignAndCreation
- summary: returns models
- description: returns models
- operationId: getServiceDesignAndCreationModels
+ summary: returns element-choice-sets
+ description: returns element-choice-sets
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/models"
+ $ref: "#/definitions/element-choice-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship:
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
put:
tags:
- ServiceDesignAndCreation
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: related-lookup-uuid
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
in: path
required: true
type: string
- ServiceDesignAndCreation
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: related-lookup-uuid
+ - name: model-element-uuid
in: path
required: true
type: string
- /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}:
- get:
- tags:
- - ServiceDesignAndCreation
- summary: returns related-lookup
- description: returns related-lookup
- operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns constrained-element-set
+ description: returns constrained-element-set
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/related-lookup"
+ $ref: "#/definitions/constrained-element-set"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: related-lookup-uuid
+ - name: model-element-uuid
in: path
required: true
type: string
- - name: named-query-name
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
required: false
type: string
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing related-lookup
- description: create or update an existing related-lookup
- operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
+ summary: create or update an existing constrained-element-set
+ description: create or update an existing constrained-element-set
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: related-lookup-uuid
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
in: path
required: true
type: string
- name: body
in: body
- description: related-lookup object that needs to be created or updated
+ description: constrained-element-set object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/related-lookup"
+ $ref: "#/definitions/constrained-element-set"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing related-lookup
- description: delete an existing related-lookup
- operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
+ summary: delete an existing constrained-element-set
+ description: delete an existing constrained-element-set
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: related-lookup-uuid
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
in: path
required: true
type: string
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
get:
tags:
- ServiceDesignAndCreation
- summary: returns related-lookups
- description: returns related-lookups
- operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
+ summary: returns constrained-element-sets
+ description: returns constrained-element-sets
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/related-lookups"
+ $ref: "#/definitions/constrained-element-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: named-query-name
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-type
in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
required: false
type: string
- /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}:
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
get:
tags:
- ServiceDesignAndCreation
- summary: returns property-constraint
- description: returns property-constraint
- operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
+ summary: returns model-constraint
+ description: returns model-constraint
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/property-constraint"
+ $ref: "#/definitions/model-constraint"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-element-uuid
in: path
required: true
type: string
- - name: property-constraint-uuid
+ - name: model-constraint-uuid
in: path
required: true
type: string
- - name: named-query-name
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
required: false
type: string
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing property-constraint
- description: create or update an existing property-constraint
- operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
+ summary: create or update an existing model-constraint
+ description: create or update an existing model-constraint
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: property-constraint-uuid
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-constraint-uuid
in: path
required: true
type: string
- name: body
in: body
- description: property-constraint object that needs to be created or updated
+ description: model-constraint object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/property-constraint"
+ $ref: "#/definitions/model-constraint"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing property-constraint
- description: delete an existing property-constraint
- operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
+ summary: delete an existing model-constraint
+ description: delete an existing model-constraint
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-element-uuid
in: path
required: true
type: string
- - name: property-constraint-uuid
+ - name: model-constraint-uuid
in: path
required: true
type: string
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
get:
tags:
- ServiceDesignAndCreation
- summary: returns property-constraints
- description: returns property-constraints
- operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
+ summary: returns model-constraints
+ description: returns model-constraints
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/property-constraints"
+ $ref: "#/definitions/model-constraints"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: named-query-name
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-type
in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
required: false
type: string
- /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
put:
tags:
- ServiceDesignAndCreation
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-element-uuid
in: path
required: true
type: string
- ServiceDesignAndCreation
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
get:
tags:
- ServiceDesignAndCreation
- summary: returns named-query-element
- description: returns named-query-element
- operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
+ summary: returns model-element
+ description: returns model-element
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/named-query-element"
+ $ref: "#/definitions/model-element"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: named-query-name
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
in: query
+ description: Version
required: false
type: string
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing named-query-element
- description: create or update an existing named-query-element
- operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
+ summary: create or update an existing model-element
+ description: create or update an existing model-element
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-element-uuid
in: path
required: true
type: string
- name: body
in: body
- description: named-query-element object that needs to be created or updated
+ description: model-element object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/named-query-element"
+ $ref: "#/definitions/model-element"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing named-query-element
- description: delete an existing named-query-element
- operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
+ summary: delete an existing model-element
+ description: delete an existing model-element
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-element-uuid
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-element-uuid
in: path
required: true
type: string
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
get:
tags:
- ServiceDesignAndCreation
- summary: returns named-query-elements
- description: returns named-query-elements
- operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
+ summary: returns model-elements
+ description: returns model-elements
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/named-query-elements"
+ $ref: "#/definitions/model-elements"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-name
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-type
in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
required: false
type: string
- /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
put:
tags:
- ServiceDesignAndCreation
- summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
+ summary: create or update an existing metadatum
+ description: create or update an existing metadatum
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: metaname
in: path
required: true
type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: metadatum object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/metadatum"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
get:
tags:
- ServiceDesignAndCreation
- summary: returns named-query
- description: returns named-query
- operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
+ summary: returns metadata
+ description: returns metadata
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/named-query"
+ $ref: "#/definitions/metadata"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: named-query-name
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
in: query
+ description: Version
required: false
type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing named-query
- description: create or update an existing named-query
- operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- name: body
in: body
- description: named-query object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/named-query"
+ $ref: "#/definitions/relationship"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing named-query
- description: delete an existing named-query
- operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: named-query-uuid
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns model-ver
+ description: returns model-ver
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/model-ver"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing model-ver
+ description: create or update an existing model-ver
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
+ 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: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: model-ver object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/model-ver"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing model-ver
+ description: delete an existing model-ver
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
+ 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: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/named-queries:
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
get:
tags:
- ServiceDesignAndCreation
- summary: returns named-queries
- description: returns named-queries
- operationId: getServiceDesignAndCreationNamedQueries
+ summary: returns model-vers
+ description: returns model-vers
+ operationId: getServiceDesignAndCreationModelsModelModelVers
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/named-queries"
+ $ref: "#/definitions/model-vers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
put:
tags:
- - Network
+ - ServiceDesignAndCreation
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: link-name
+ - name: model-invariant-id
in: path
- description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - Network
+ - ServiceDesignAndCreation
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
+ operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: link-name
+ - name: model-invariant-id
in: path
- description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- /network/logical-links/logical-link/{link-name}:
+ /service-design-and-creation/models/model/{model-invariant-id}:
get:
tags:
- - Network
- summary: returns logical-link
- description: returns logical-link
- operationId: getNetworkLogicalLinksLogicalLink
+ - ServiceDesignAndCreation
+ summary: returns model
+ description: returns model
+ operationId: getServiceDesignAndCreationModelsModel
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/logical-link"
+ $ref: "#/definitions/model"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: link-name
+ - name: model-invariant-id
in: path
- description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: link-id
- in: query
- description: UUID of the logical-link, SDNC generates this.
- required: false
- type: string
- - name: circuit-id
- in: query
- description: Circuit id
- required: false
- type: string
- - name: purpose
+ - name: model-type
in: query
- description: Reason for this entity, role it is playing
+ description: Type of the model, e.g., service, resource, widget, etc.
required: false
type: string
put:
tags:
- - Network
- summary: create or update an existing logical-link
- description: create or update an existing logical-link
- operationId: createOrUpdateNetworkLogicalLinksLogicalLink
+ - ServiceDesignAndCreation
+ summary: create or update an existing model
+ description: create or update an existing model
+ operationId: createOrUpdateServiceDesignAndCreationModelsModel
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: link-name
+ - name: model-invariant-id
in: path
- description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- name: body
in: body
- description: logical-link object that needs to be created or updated
+ description: model object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/logical-link"
+ $ref: "#/definitions/model"
delete:
tags:
- - Network
- summary: delete an existing logical-link
- description: delete an existing logical-link
- operationId: deleteNetworkLogicalLinksLogicalLink
+ - ServiceDesignAndCreation
+ summary: delete an existing model
+ description: delete an existing model
+ operationId: deleteServiceDesignAndCreationModelsModel
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: link-name
+ - name: model-invariant-id
in: path
- description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/logical-links:
+ /service-design-and-creation/models:
get:
tags:
- - Network
- summary: returns logical-links
- description: returns logical-links
- operationId: getNetworkLogicalLinks
+ - ServiceDesignAndCreation
+ summary: returns models
+ description: returns models
+ operationId: getServiceDesignAndCreationModels
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/logical-links"
+ $ref: "#/definitions/models"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship:
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship:
put:
tags:
- - Network
+ - ServiceDesignAndCreation
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
- in: path
- description: Unique id of site pair set.
- required: true
- type: string
- - name: routing-instance-id
+ - name: named-query-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
+ - name: named-query-element-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- - name: cos
+ - name: related-lookup-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - Network
+ - ServiceDesignAndCreation
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
- in: path
- description: Unique id of site pair set.
- required: true
- type: string
- - name: routing-instance-id
+ - name: named-query-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
+ - name: named-query-element-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- - name: cos
+ - name: related-lookup-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}:
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}:
get:
tags:
- - Network
- summary: returns class-of-service
- description: returns class-of-service
- operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ - ServiceDesignAndCreation
+ summary: returns related-lookup
+ description: returns related-lookup
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/class-of-service"
+ $ref: "#/definitions/related-lookup"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: named-query-uuid
in: path
- description: Unique id of site pair set.
required: true
type: string
- - name: routing-instance-id
+ - name: named-query-element-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
+ - name: related-lookup-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- - name: cos
- in: path
- description: unique identifier of probe
- required: true
+ - name: named-query-name
+ in: query
+ required: false
type: string
put:
tags:
- - Network
- summary: create or update an existing class-of-service
- description: create or update an existing class-of-service
- operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ - ServiceDesignAndCreation
+ summary: create or update an existing related-lookup
+ description: create or update an existing related-lookup
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
- in: path
- description: Unique id of site pair set.
- required: true
- type: string
- - name: routing-instance-id
+ - name: named-query-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
+ - name: named-query-element-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- - name: cos
+ - name: related-lookup-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- name: body
in: body
- description: class-of-service object that needs to be created or updated
+ description: related-lookup object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/class-of-service"
+ $ref: "#/definitions/related-lookup"
delete:
tags:
- - Network
- summary: delete an existing class-of-service
- description: delete an existing class-of-service
- operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ - ServiceDesignAndCreation
+ summary: delete an existing related-lookup
+ description: delete an existing related-lookup
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
- in: path
- description: Unique id of site pair set.
- required: true
- type: string
- - name: routing-instance-id
+ - name: named-query-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
+ - name: named-query-element-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- - name: cos
+ - name: related-lookup-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service:
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
get:
tags:
- - Network
- summary: returns classes-of-service
- description: returns classes-of-service
- operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
+ - ServiceDesignAndCreation
+ summary: returns related-lookups
+ description: returns related-lookups
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/classes-of-service"
+ $ref: "#/definitions/related-lookups"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: named-query-uuid
in: path
- description: Unique id of site pair set.
required: true
type: string
- - name: routing-instance-id
+ - name: named-query-element-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
+ - name: named-query-name
+ in: query
+ required: false
+ type: string
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns property-constraint
+ description: returns property-constraint
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/property-constraint"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship:
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: property-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: named-query-name
+ in: query
+ required: false
+ type: string
put:
tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
+ - ServiceDesignAndCreation
+ summary: create or update an existing property-constraint
+ description: create or update an existing property-constraint
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: named-query-uuid
in: path
- description: Unique id of site pair set.
required: true
type: string
- - name: routing-instance-id
+ - name: named-query-element-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
+ - name: property-constraint-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: property-constraint object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/property-constraint"
delete:
tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
+ - ServiceDesignAndCreation
+ summary: delete an existing property-constraint
+ description: delete an existing property-constraint
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: named-query-uuid
in: path
- description: Unique id of site pair set.
required: true
type: string
- - name: routing-instance-id
+ - name: named-query-element-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
+ - name: property-constraint-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}:
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
get:
tags:
- - Network
- summary: returns site-pair
- description: returns site-pair
- operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
+ - ServiceDesignAndCreation
+ summary: returns property-constraints
+ description: returns property-constraints
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/site-pair"
+ $ref: "#/definitions/property-constraints"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: named-query-uuid
in: path
- description: Unique id of site pair set.
required: true
type: string
- - name: routing-instance-id
+ - name: named-query-element-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
- in: path
- description: unique identifier of probe
- required: true
+ - name: named-query-name
+ in: query
+ required: false
type: string
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
put:
tags:
- - Network
- summary: create or update an existing site-pair
- description: create or update an existing site-pair
- operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
- in: path
- description: Unique id of site pair set.
- required: true
- type: string
- - name: routing-instance-id
+ - name: named-query-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
+ - name: named-query-element-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- name: body
in: body
- description: site-pair object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/site-pair"
+ $ref: "#/definitions/relationship"
delete:
tags:
- - Network
- summary: delete an existing site-pair
- description: delete an existing site-pair
- operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: named-query-uuid
in: path
- description: Unique id of site pair set.
required: true
type: string
- - name: routing-instance-id
+ - name: named-query-element-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- - name: site-pair-id
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns named-query-element
+ description: returns named-query-element
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/named-query-element"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: named-query-name
+ in: query
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing named-query-element
+ description: create or update an existing named-query-element
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
+ 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: named-query-uuid
+ in: path
+ required: true
+ type: string
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: named-query-element object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/named-query-element"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing named-query-element
+ description: delete an existing named-query-element
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
+ 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: named-query-uuid
+ in: path
+ required: true
+ type: string
+ - name: named-query-element-uuid
in: path
- description: unique identifier of probe
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
get:
tags:
- - Network
- summary: returns site-pairs
- description: returns site-pairs
- operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
+ - ServiceDesignAndCreation
+ summary: returns named-query-elements
+ description: returns named-query-elements
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/site-pairs"
+ $ref: "#/definitions/named-query-elements"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: named-query-uuid
in: path
- description: Unique id of site pair set.
required: true
type: string
- - name: routing-instance-id
- in: path
- description: Unique id of routing instance
- required: true
+ - name: named-query-name
+ in: query
+ required: false
type: string
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
put:
tags:
- - Network
+ - ServiceDesignAndCreation
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
- in: path
- description: Unique id of site pair set.
- required: true
- type: string
- - name: routing-instance-id
+ - name: named-query-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - Network
+ - ServiceDesignAndCreation
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
- in: path
- description: Unique id of site pair set.
- required: true
- type: string
- - name: routing-instance-id
+ - name: named-query-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
get:
tags:
- - Network
- summary: returns routing-instance
- description: returns routing-instance
- operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
+ - ServiceDesignAndCreation
+ summary: returns named-query
+ description: returns named-query
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/routing-instance"
+ $ref: "#/definitions/named-query"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: named-query-uuid
in: path
- description: Unique id of site pair set.
required: true
type: string
- - name: routing-instance-id
- in: path
- description: Unique id of routing instance
- required: true
+ - name: named-query-name
+ in: query
+ required: false
type: string
put:
tags:
- - Network
- summary: create or update an existing routing-instance
- description: create or update an existing routing-instance
- operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
+ - ServiceDesignAndCreation
+ summary: create or update an existing named-query
+ description: create or update an existing named-query
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
- in: path
- description: Unique id of site pair set.
- required: true
- type: string
- - name: routing-instance-id
+ - name: named-query-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- name: body
in: body
- description: routing-instance object that needs to be created or updated
+ description: named-query object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/routing-instance"
+ $ref: "#/definitions/named-query"
delete:
tags:
- - Network
- summary: delete an existing routing-instance
- description: delete an existing routing-instance
- operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
+ - ServiceDesignAndCreation
+ summary: delete an existing named-query
+ description: delete an existing named-query
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
- in: path
- description: Unique id of site pair set.
- required: true
- type: string
- - name: routing-instance-id
+ - name: named-query-uuid
in: path
- description: Unique id of routing instance
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
+ /service-design-and-creation/named-queries:
get:
tags:
- - Network
- summary: returns routing-instances
- description: returns routing-instances
- operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
+ - ServiceDesignAndCreation
+ summary: returns named-queries
+ description: returns named-queries
+ operationId: getServiceDesignAndCreationNamedQueries
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/routing-instances"
+ $ref: "#/definitions/named-queries"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: site-pair-set-id
- in: path
- description: Unique id of site pair set.
- required: true
- type: string
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
+ /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
+ operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: link-name
in: path
- description: Unique id of site pair set.
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
+ operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: link-name
in: path
- description: Unique id of site pair set.
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
required: true
type: string
- /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
+ /network/logical-links/logical-link/{link-name}:
get:
tags:
- Network
- summary: returns site-pair-set
- description: returns site-pair-set
- operationId: getNetworkSitePairSetsSitePairSet
+ summary: returns logical-link
+ description: returns logical-link
+ operationId: getNetworkLogicalLinksLogicalLink
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/site-pair-set"
+ $ref: "#/definitions/logical-link"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: link-name
in: path
- description: Unique id of site pair set.
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
required: true
type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ 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: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: link-id
+ in: query
+ description: UUID of the logical-link, SDNC generates this.
+ required: false
+ type: string
+ - name: circuit-id
+ in: query
+ description: Circuit id
+ required: false
+ type: string
+ - name: purpose
+ in: query
+ description: Reason for this entity, role it is playing
+ required: false
+ type: string
put:
tags:
- Network
- summary: create or update an existing site-pair-set
- description: create or update an existing site-pair-set
- operationId: createOrUpdateNetworkSitePairSetsSitePairSet
+ summary: create or update an existing logical-link
+ description: create or update an existing logical-link
+ operationId: createOrUpdateNetworkLogicalLinksLogicalLink
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: link-name
in: path
- description: Unique id of site pair set.
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
required: true
type: string
- name: body
in: body
- description: site-pair-set object that needs to be created or updated
+ description: logical-link object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/site-pair-set"
+ $ref: "#/definitions/logical-link"
delete:
tags:
- Network
- summary: delete an existing site-pair-set
- description: delete an existing site-pair-set
- operationId: deleteNetworkSitePairSetsSitePairSet
+ summary: delete an existing logical-link
+ description: delete an existing logical-link
+ operationId: deleteNetworkLogicalLinksLogicalLink
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: site-pair-set-id
+ - name: link-name
in: path
- description: Unique id of site pair set.
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/site-pair-sets:
+ /network/logical-links:
get:
tags:
- Network
- summary: returns site-pair-sets
- description: returns site-pair-sets
- operationId: getNetworkSitePairSets
+ summary: returns logical-links
+ description: returns logical-links
+ operationId: getNetworkLogicalLinks
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/site-pair-sets"
+ $ref: "#/definitions/logical-links"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
required: true
type: string
- - name: global-route-target
+ - name: routing-instance-id
in: path
- description: Number used to identify an RT, globally unique in the network
+ description: Unique id of routing instance
required: true
type: string
- - name: route-target-role
+ - name: site-pair-id
in: path
- description: Role assigned to this route target
+ description: unique identifier of probe
+ required: true
+ type: string
+ - name: cos
+ in: path
+ description: unique identifier of probe
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
required: true
type: string
- - name: global-route-target
+ - name: routing-instance-id
in: path
- description: Number used to identify an RT, globally unique in the network
+ description: Unique id of routing instance
required: true
type: string
- - name: route-target-role
+ - name: site-pair-id
in: path
- description: Role assigned to this route target
+ description: unique identifier of probe
required: true
type: string
- /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
+ - name: cos
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}:
get:
tags:
- Network
- summary: returns route-target
- description: returns route-target
- operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ summary: returns class-of-service
+ description: returns class-of-service
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/route-target"
+ $ref: "#/definitions/class-of-service"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
required: true
type: string
- - name: global-route-target
+ - name: routing-instance-id
in: path
- description: Number used to identify an RT, globally unique in the network
+ description: Unique id of routing instance
required: true
type: string
- - name: route-target-role
+ - name: site-pair-id
in: path
- description: Role assigned to this route target
+ description: unique identifier of probe
required: true
type: string
- - name: vpn-name
- in: query
- description: VPN Name
- required: false
- type: string
- - name: vpn-type
- in: query
- description: Type of the vpn, should be taken from enumerated/valid values
- required: false
+ - name: cos
+ in: path
+ description: unique identifier of probe
+ required: true
type: string
put:
tags:
- Network
- summary: create or update an existing route-target
- description: create or update an existing route-target
- operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ summary: create or update an existing class-of-service
+ description: create or update an existing class-of-service
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
required: true
type: string
- - name: global-route-target
+ - name: routing-instance-id
in: path
- description: Number used to identify an RT, globally unique in the network
+ description: Unique id of routing instance
required: true
type: string
- - name: route-target-role
+ - name: site-pair-id
in: path
- description: Role assigned to this route target
+ description: unique identifier of probe
+ required: true
+ type: string
+ - name: cos
+ in: path
+ description: unique identifier of probe
required: true
type: string
- name: body
in: body
- description: route-target object that needs to be created or updated
+ description: class-of-service object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/route-target"
+ $ref: "#/definitions/class-of-service"
delete:
tags:
- Network
- summary: delete an existing route-target
- description: delete an existing route-target
- operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ summary: delete an existing class-of-service
+ description: delete an existing class-of-service
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
required: true
type: string
- - name: global-route-target
+ - name: routing-instance-id
in: path
- description: Number used to identify an RT, globally unique in the network
+ description: Unique id of routing instance
required: true
type: string
- - name: route-target-role
+ - name: site-pair-id
in: path
- description: Role assigned to this route target
+ description: unique identifier of probe
+ required: true
+ type: string
+ - name: cos
+ in: path
+ description: unique identifier of probe
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service:
get:
tags:
- Network
- summary: returns route-targets
- description: returns route-targets
- operationId: getNetworkVpnBindingsVpnBindingRouteTargets
+ summary: returns classes-of-service
+ description: returns classes-of-service
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/route-targets"
+ $ref: "#/definitions/classes-of-service"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
required: true
type: string
- - name: vpn-name
- in: query
- description: VPN Name
- required: false
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
type: string
- - name: vpn-type
- in: query
- description: Type of the vpn, should be taken from enumerated/valid values
- required: false
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
type: string
- /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
required: true
type: string
- /network/vpn-bindings/vpn-binding/{vpn-id}:
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}:
get:
tags:
- Network
- summary: returns vpn-binding
- description: returns vpn-binding
- operationId: getNetworkVpnBindingsVpnBinding
+ summary: returns site-pair
+ description: returns site-pair
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vpn-binding"
+ $ref: "#/definitions/site-pair"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
required: true
type: string
- - name: vpn-name
- in: query
- description: VPN Name
- required: false
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
type: string
- - name: vpn-type
- in: query
- description: Type of the vpn, should be taken from enumerated/valid values
- required: false
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
type: string
put:
tags:
- Network
- summary: create or update an existing vpn-binding
- description: create or update an existing vpn-binding
- operationId: createOrUpdateNetworkVpnBindingsVpnBinding
+ summary: create or update an existing site-pair
+ description: create or update an existing site-pair
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
required: true
type: string
- name: body
in: body
- description: vpn-binding object that needs to be created or updated
+ description: site-pair object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/vpn-binding"
+ $ref: "#/definitions/site-pair"
delete:
tags:
- Network
- summary: delete an existing vpn-binding
- description: delete an existing vpn-binding
- operationId: deleteNetworkVpnBindingsVpnBinding
+ summary: delete an existing site-pair
+ description: delete an existing site-pair
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vpn-id
+ - name: site-pair-set-id
in: path
- description: VPN ID, globally unique within A&AI
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/vpn-bindings:
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
get:
tags:
- Network
- summary: returns vpn-bindings
- description: returns vpn-bindings
- operationId: getNetworkVpnBindings
+ summary: returns site-pairs
+ description: returns site-pairs
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vpn-bindings"
+ $ref: "#/definitions/site-pairs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ - name: routing-instance-id
in: path
+ description: Unique id of routing instance
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
+ - name: site-pair-set-id
in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
+ get:
+ tags:
+ - Network
+ summary: returns routing-instance
+ description: returns routing-instance
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/routing-instance"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
put:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
+ summary: create or update an existing routing-instance
+ description: create or update an existing routing-instance
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
+ - name: site-pair-set-id
in: path
+ description: Unique id of site pair set.
required: true
type: string
- - name: interface-name
+ - name: routing-instance-id
in: path
- description: Name that identifies the physical interface
+ description: Unique id of routing instance
required: true
type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: routing-instance object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/routing-instance"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
+ summary: delete an existing routing-instance
+ description: delete an existing routing-instance
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
+ - name: site-pair-set-id
in: path
+ description: Unique id of site pair set.
required: true
type: string
- - name: interface-name
+ - name: routing-instance-id
in: path
- description: Name that identifies the physical interface
+ description: Unique id of routing instance
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
+ get:
+ tags:
+ - Network
+ summary: returns routing-instances
+ description: returns routing-instances
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/routing-instances"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: pf-pci-id
+ - name: site-pair-set-id
in: path
- description: Identifier for the sriov-pf
+ description: Unique id of site pair set.
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: pf-pci-id
+ - name: site-pair-set-id
in: path
- description: Identifier for the sriov-pf
+ description: Unique id of site pair set.
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
get:
tags:
- Network
- summary: returns sriov-pf
- description: returns sriov-pf
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
+ summary: returns site-pair-set
+ description: returns site-pair-set
+ operationId: getNetworkSitePairSetsSitePairSet
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-pf"
+ $ref: "#/definitions/site-pair-set"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: pf-pci-id
+ - name: site-pair-set-id
in: path
- description: Identifier for the sriov-pf
+ description: Unique id of site pair set.
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- 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
put:
tags:
- Network
- summary: create or update an existing sriov-pf
- description: create or update an existing sriov-pf
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
+ summary: create or update an existing site-pair-set
+ description: create or update an existing site-pair-set
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSet
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: pf-pci-id
+ - name: site-pair-set-id
in: path
- description: Identifier for the sriov-pf
+ description: Unique id of site pair set.
required: true
type: string
- name: body
in: body
- description: sriov-pf object that needs to be created or updated
+ description: site-pair-set object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/sriov-pf"
+ $ref: "#/definitions/site-pair-set"
delete:
tags:
- Network
- summary: delete an existing sriov-pf
- description: delete an existing sriov-pf
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
+ summary: delete an existing site-pair-set
+ description: delete an existing site-pair-set
+ operationId: deleteNetworkSitePairSetsSitePairSet
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: pf-pci-id
+ - name: site-pair-set-id
in: path
- description: Identifier for the sriov-pf
+ description: Unique id of site pair set.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
+ /network/site-pair-sets:
get:
tags:
- Network
- summary: returns sriov-pfs
- description: returns sriov-pfs
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
+ summary: returns site-pair-sets
+ description: returns site-pair-sets
+ operationId: getNetworkSitePairSets
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-pfs"
+ $ref: "#/definitions/site-pair-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- 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
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
+ /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
+ - name: vpn-id
in: path
- description: Name that identifies the physical interface
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- - name: interface-name
+ - name: global-route-target
in: path
- description: Name given to the interface
+ description: Number used to identify an RT, globally unique in the network
required: true
type: string
- - name: vlan-interface
+ - name: route-target-role
in: path
- description: String that identifies the interface
+ description: Role assigned to this route target
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
+ - name: vpn-id
in: path
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- - name: interface-name
+ - name: global-route-target
in: path
- description: Name that identifies the physical interface
+ description: Number used to identify an RT, globally unique in the network
required: true
type: string
- - name: interface-name
+ - name: route-target-role
in: path
- description: Name given to the interface
+ description: Role assigned to this route target
required: true
type: string
- - name: vlan-interface
+ /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
+ get:
+ tags:
+ - Network
+ summary: returns route-target
+ description: returns route-target
+ operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/route-target"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
in: path
- description: String that identifies the interface
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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:
+ - name: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ - name: vpn-name
+ in: query
+ description: VPN Name
+ required: false
+ type: string
+ - name: vpn-type
+ in: query
+ description: Type of the vpn, should be taken from enumerated/valid values
+ required: false
+ type: string
put:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ summary: create or update an existing route-target
+ description: create or update an existing route-target
+ operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
+ - name: vpn-id
in: path
- description: Name given to the interface
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- - name: vlan-interface
+ - name: global-route-target
in: path
- description: String that identifies the interface
+ description: Number used to identify an RT, globally unique in the network
required: true
type: string
- - name: l3-interface-ipv4-address
+ - name: route-target-role
in: path
- description: IP address
+ description: Role assigned to this route target
required: true
type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: route-target object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/route-target"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ summary: delete an existing route-target
+ description: delete an existing route-target
+ operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
+ - name: vpn-id
in: path
- description: Name that identifies the physical interface
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- - name: interface-name
+ - name: global-route-target
in: path
- description: Name given to the interface
+ description: Number used to identify an RT, globally unique in the network
required: true
type: string
- - name: vlan-interface
+ - name: route-target-role
in: path
- description: String that identifies the interface
+ description: Role assigned to this route target
required: true
type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
+ /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
get:
tags:
- Network
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: returns route-targets
+ description: returns route-targets
+ operationId: getNetworkVpnBindingsVpnBindingRouteTargets
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/definitions/route-targets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical 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
+ - name: vpn-id
in: path
- description: IP address
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: prov-status
+ - name: vpn-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: VPN Name
required: false
type: string
- - name: interface-id
+ - name: vpn-type
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-key
- 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
+ description: Type of the vpn, should be taken from enumerated/valid values
required: false
type: string
+ /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical 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
+ - name: vpn-id
in: path
- description: IP address
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: equipment-name
+ - name: vpn-id
in: path
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- - name: interface-name
+ /network/vpn-bindings/vpn-binding/{vpn-id}:
+ get:
+ tags:
+ - Network
+ summary: returns vpn-binding
+ description: returns vpn-binding
+ operationId: getNetworkVpnBindingsVpnBinding
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vpn-binding"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
in: path
- description: Name that identifies the physical interface
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
+ - name: vpn-name
+ in: query
+ description: VPN Name
+ required: false
type: string
- - name: vlan-interface
+ - name: vpn-type
+ in: query
+ description: Type of the vpn, should be taken from enumerated/valid values
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vpn-binding
+ description: create or update an existing vpn-binding
+ operationId: createOrUpdateNetworkVpnBindingsVpnBinding
+ 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: vpn-id
in: path
- description: String that identifies the interface
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- - name: l3-interface-ipv4-address
+ - name: body
+ in: body
+ description: vpn-binding object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/vpn-binding"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vpn-binding
+ description: delete an existing vpn-binding
+ operationId: deleteNetworkVpnBindingsVpnBinding
+ 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: vpn-id
in: path
- description: IP address
+ description: VPN ID, globally unique within A&AI
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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:
+ /network/vpn-bindings:
+ get:
+ tags:
+ - Network
+ summary: returns vpn-bindings
+ description: returns vpn-bindings
+ operationId: getNetworkVpnBindings
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vpn-bindings"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
consumes:
- application/json
- application/xml
in: path
required: true
type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical 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
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
consumes:
- application/json
- application/xml
in: path
required: true
type: string
- - name: interface-name
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
+ 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: equipment-name
in: path
- description: Name that identifies the physical 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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
required: true
- type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
- get:
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
tags:
- Network
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
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:
description: Name that identifies the physical 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- 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: 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-key
- 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
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Name that identifies the physical 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
+ - name: pf-pci-id
in: path
- description: IP address
+ description: Identifier for the sriov-pf
required: true
type: string
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Name that identifies the physical 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
+ - name: pf-pci-id
in: path
- description: IP address
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ description: Identifier for the sriov-pf
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
get:
tags:
- Network
- summary: returns vlan
- description: returns vlan
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ summary: returns sriov-pf
+ description: returns sriov-pf
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/definitions/sriov-pf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Name that identifies the physical interface
required: true
type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
+ - name: pf-pci-id
in: path
- description: String that identifies the interface
+ description: Identifier for the sriov-pf
required: true
type: string
- name: prov-status
description: Trigger for operational monitoring of this resource by Service Assurance systems.
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-key
- 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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ summary: create or update an existing sriov-pf
+ description: create or update an existing sriov-pf
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
consumes:
- application/json
- application/xml
description: Name that identifies the physical interface
required: true
type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
+ - name: pf-pci-id
in: path
- description: String that identifies the interface
+ description: Identifier for the sriov-pf
required: true
type: string
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: sriov-pf object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/definitions/sriov-pf"
delete:
tags:
- Network
- summary: delete an existing vlan
- description: delete an existing vlan
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ summary: delete an existing sriov-pf
+ description: delete an existing sriov-pf
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
consumes:
- application/json
- application/xml
description: Name that identifies the physical interface
required: true
type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
+ - name: pf-pci-id
in: path
- description: String that identifies the interface
+ description: Identifier for the sriov-pf
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
get:
tags:
- Network
- summary: returns vlans
- description: returns vlans
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
+ summary: returns sriov-pfs
+ description: returns sriov-pfs
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/definitions/sriov-pfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Name that identifies the physical interface
required: true
type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
description: Trigger for operational monitoring of this resource by Service Assurance systems.
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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Name given to the interface
required: true
type: string
- - name: pci-id
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ description: String that identifies the interface
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Name given to the interface
required: true
type: string
- - name: pci-id
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ description: String that identifies the interface
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
- get:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: returns sriov-vf
- description: returns sriov-vf
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
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:
description: Name given to the interface
required: true
type: string
- - name: pci-id
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ description: String that identifies the interface
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- 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: 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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical 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: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
- get:
- tags:
- - Network
- summary: returns sriov-vfs
- description: returns sriov-vfs
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- 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: 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
+ - name: l3-interface-ipv4-address
in: path
- description: Name given to the interface
+ description: IP address
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
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: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
+ - name: vlan-interface
in: path
- description: Name given to the interface
+ description: String that identifies the interface
required: true
type: string
- name: l3-interface-ipv4-address
description: IP address
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
produces:
- application/json
- application/xml
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: false
type: integer
format: int64
+ - name: vpn-key
+ 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
- Network
summary: create or update an existing l3-interface-ipv4-address-list
description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
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
- Network
summary: delete an existing l3-interface-ipv4-address-list
description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
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
description: resource-version for concurrency
required: true
type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
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
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
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: 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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical 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: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
- get:
- tags:
- - Network
- summary: returns l-interface
- description: returns l-interface
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- 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: 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
+ - name: vpn-key
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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical 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: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
- get:
- tags:
- - Network
- summary: returns l-interfaces
- description: returns l-interfaces
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- 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
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
- get:
- tags:
- - Network
- summary: returns p-interface
- description: returns p-interface
- operationId: getNetworkVplsPesVplsPePInterfacesPInterface
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/p-interface"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- 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
- put:
- tags:
- - Network
- summary: create or update an existing p-interface
- description: create or update an existing p-interface
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: body
- in: body
- description: p-interface object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/p-interface"
- delete:
- tags:
- - Network
- summary: delete an existing p-interface
- description: delete an existing p-interface
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
- get:
- tags:
- - Network
- summary: returns p-interfaces
- description: returns p-interfaces
- operationId: getNetworkVplsPesVplsPePInterfaces
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/p-interfaces"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
- 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: equipment-name
- in: path
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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-key
- 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- 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: equipment-name
- in: path
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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-key
- 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
- 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: equipment-name
- in: path
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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-key
- 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
- get:
- tags:
- - Network
- summary: returns vlans
- description: returns vlans
- operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
- 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: equipment-name
- in: path
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- 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: equipment-name
- in: path
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
- 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: equipment-name
- in: path
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
- 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: equipment-name
- in: path
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/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: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
- 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: equipment-name
- in: path
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
- get:
- tags:
- - Network
- summary: returns l-interface
- description: returns l-interface
- operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
- 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: equipment-name
- in: path
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
- get:
- tags:
- - Network
- summary: returns l-interfaces
- description: returns l-interfaces
- operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- required: false
- type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
- get:
- tags:
- - Network
- summary: returns lag-interface
- description: returns lag-interface
- operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing lag-interface
- description: create or update an existing lag-interface
- operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
- 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: equipment-name
- in: path
- 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
- 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: equipment-name
- in: path
- 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
- get:
- tags:
- - Network
- summary: returns lag-interfaces
- description: returns lag-interfaces
- operationId: getNetworkVplsPesVplsPeLagInterfaces
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- /network/vpls-pes/vpls-pe/{equipment-name}:
- get:
- tags:
- - Network
- summary: returns vpls-pe
- description: returns vpls-pe
- operationId: getNetworkVplsPesVplsPe
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vpls-pe"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing vpls-pe
- description: create or update an existing vpls-pe
- operationId: createOrUpdateNetworkVplsPesVplsPe
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: body
- in: body
- description: vpls-pe object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/vpls-pe"
- delete:
- tags:
- - Network
- summary: delete an existing vpls-pe
- description: delete an existing vpls-pe
- operationId: deleteNetworkVplsPesVplsPe
- 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: equipment-name
- in: path
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpls-pes:
- get:
- tags:
- - Network
- summary: returns vpls-pes
- description: returns vpls-pes
- operationId: getNetworkVplsPes
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vpls-pes"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
- 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: multicast-configuration-id
- in: path
- description: Unique id of multicast configuration.
- 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: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
- 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: multicast-configuration-id
- in: path
- description: Unique id of multicast configuration.
- required: true
- type: string
- /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
- get:
- tags:
- - Network
- summary: returns multicast-configuration
- description: returns multicast-configuration
- operationId: getNetworkMulticastConfigurationsMulticastConfiguration
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/multicast-configuration"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: multicast-configuration-id
- in: path
- description: Unique id of multicast configuration.
- required: true
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing multicast-configuration
- description: create or update an existing multicast-configuration
- operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
- 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: multicast-configuration-id
- in: path
- description: Unique id of multicast configuration.
- required: true
- type: string
- - name: body
- in: body
- description: multicast-configuration object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/multicast-configuration"
- delete:
- tags:
- - Network
- summary: delete an existing multicast-configuration
- description: delete an existing multicast-configuration
- operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
- 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: multicast-configuration-id
- in: path
- description: Unique id of multicast configuration.
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/multicast-configurations:
- get:
- tags:
- - Network
- summary: returns multicast-configurations
- description: returns multicast-configurations
- operationId: getNetworkMulticastConfigurations
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/multicast-configurations"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
- 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-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- - name: cvlan-tag
- in: path
- description: See mis-na-virtualization-platform.yang
- 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: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
- 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-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- - name: cvlan-tag
- in: path
- description: See mis-na-virtualization-platform.yang
- required: true
- type: integer
- format: int64
- /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
- get:
- tags:
- - Network
- summary: returns cvlan-tag-entry
- description: returns cvlan-tag-entry
- operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/cvlan-tag-entry"
- "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-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- - name: cvlan-tag
- in: path
- description: See mis-na-virtualization-platform.yang
- required: true
- type: integer
- format: int64
- - 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- 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: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- 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 cvlan-tag-entry
- description: create or update an existing cvlan-tag-entry
- operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
- 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-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- - name: cvlan-tag
- in: path
- description: See mis-na-virtualization-platform.yang
- required: true
- type: integer
- format: int64
- - name: body
- in: body
- description: cvlan-tag-entry object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/cvlan-tag-entry"
- delete:
- tags:
- - Network
- summary: delete an existing cvlan-tag-entry
- description: delete an existing cvlan-tag-entry
- operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
- 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-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- - name: cvlan-tag
- in: path
- description: See mis-na-virtualization-platform.yang
- required: true
- type: integer
- format: int64
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
- get:
- tags:
- - Network
- summary: returns cvlan-tags
- description: returns cvlan-tags
- operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/cvlan-tags"
- "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-id
- in: path
- description: Unique ID of 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- 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: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- 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/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
- 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-id
- in: path
- description: Unique ID of 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: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
- 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-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
- get:
- tags:
- - Network
- summary: returns port-group
- description: returns port-group
- operationId: getNetworkVcesVcePortGroupsPortGroup
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/port-group"
- "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-id
- in: path
- description: Unique ID of 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- 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: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- 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 port-group
- description: create or update an existing port-group
- operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
- 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-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- - name: body
- in: body
- description: port-group object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/port-group"
- delete:
- tags:
- - Network
- summary: delete an existing port-group
- description: delete an existing port-group
- operationId: deleteNetworkVcesVcePortGroupsPortGroup
- 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-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vces/vce/{vnf-id}/port-groups:
- get:
- tags:
- - Network
- summary: returns port-groups
- description: returns port-groups
- operationId: getNetworkVcesVcePortGroups
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/port-groups"
- "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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- 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: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
- /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
- 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: group-uuid
- in: path
- description: Unique ID for the license group the resource belongs to, should be uuid.
- required: true
- type: string
- - name: resource-uuid
- in: path
- description: Unique ID of a license resource.
- 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: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
- 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: group-uuid
- in: path
- description: Unique ID for the license group the resource belongs to, should be uuid.
- required: true
- type: string
- - name: resource-uuid
- in: path
- description: Unique ID of a license resource.
- required: true
- type: string
- /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
- get:
- tags:
- - Network
- summary: returns license
- description: returns license
- operationId: getNetworkVcesVceLicensesLicense
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/license"
- "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: group-uuid
- in: path
- description: Unique ID for the license group the resource belongs to, should be uuid.
- required: true
- type: string
- - name: resource-uuid
- in: path
- description: Unique ID of a license resource.
- 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- 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: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing license
- description: create or update an existing license
- operationId: createOrUpdateNetworkVcesVceLicensesLicense
- 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: group-uuid
- in: path
- description: Unique ID for the license group the resource belongs to, should be uuid.
- required: true
- type: string
- - name: resource-uuid
- in: path
- description: Unique ID of a license resource.
- required: true
- type: string
- - name: body
- in: body
- description: license object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/license"
- delete:
- tags:
- - Network
- summary: delete an existing license
- description: delete an existing license
- operationId: deleteNetworkVcesVceLicensesLicense
- 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: group-uuid
- in: path
- description: Unique ID for the license group the resource belongs to, should be uuid.
- required: true
- type: string
- - name: resource-uuid
- in: path
- description: Unique ID of a license resource.
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vces/vce/{vnf-id}/licenses:
- get:
- tags:
- - Network
- summary: returns licenses
- description: returns licenses
- operationId: getNetworkVcesVceLicenses
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/licenses"
- "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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: This indicates the customers VPN ID associated with this vlan
required: false
type: string
- - name: prov-status
+ - name: vlan-id-inner
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: Inner VLAN tag
required: false
- type: string
- - name: heat-stack-id
+ type: integer
+ format: int64
+ - name: neutron-network-id
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description: Neutron network id of the interface that address belongs to
required: false
type: string
- - name: vpe-id
+ - name: neutron-subnet-id
in: query
- description: Unique ID of VPE connected to this VCE.
+ description: Neutron id of subnet that address belongs to
required: false
type: string
- /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
put:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: create or update an existing l3-interface-ipv6-address-list
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: group-uuid
+ - name: interface-name
in: path
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ description: Name that identifies the physical interface
required: true
type: string
- - name: resource-uuid
+ - name: interface-name
in: path
- description: Unique ID of an entitlement resource.
+ 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
+ description: l3-interface-ipv6-address-list object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: group-uuid
+ - name: interface-name
in: path
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ description: Name that identifies the physical interface
required: true
type: string
- - name: resource-uuid
+ - name: interface-name
in: path
- description: Unique ID of an entitlement resource.
+ description: Name given to the interface
required: true
type: string
- /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
+ - 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
get:
tags:
- Network
- summary: returns entitlement
- description: returns entitlement
- operationId: getNetworkVcesVceEntitlementsEntitlement
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/entitlement"
+ $ref: "#/definitions/vlan"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: group-uuid
+ - name: interface-name
in: path
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ description: Name that identifies the physical interface
required: true
type: string
- - name: resource-uuid
+ - name: interface-name
in: path
- description: Unique ID of an entitlement resource.
+ description: Name given to the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: vnf-name2
+ - name: prov-status
in: query
- description: Alternate name of VNF.
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- - name: vnf-type
+ - name: prov-status
in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
required: false
type: string
- - name: service-id
+ - name: interface-id
in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ description: ID of interface
required: false
type: string
- - name: regional-resource-zone
+ - name: macaddr
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: MAC address for the interface
required: false
type: string
- - name: prov-status
+ - name: network-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: Name of the network
required: false
type: string
- - name: heat-stack-id
+ - name: vlan-id-inner
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description: Inner VLAN tag
required: false
- type: string
- - name: vpe-id
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Unique ID of VPE connected to this VCE.
+ description: This indicates the customers VPN ID associated with this vlan
required: false
type: string
put:
tags:
- Network
- summary: create or update an existing entitlement
- description: create or update an existing entitlement
- operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
+ summary: create or update an existing vlan
+ description: create or update an existing vlan
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: group-uuid
+ - name: interface-name
in: path
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ description: Name that identifies the physical interface
required: true
type: string
- - name: resource-uuid
+ - name: interface-name
in: path
- description: Unique ID of an entitlement resource.
+ 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: entitlement object that needs to be created or updated
+ description: vlan object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/entitlement"
+ $ref: "#/definitions/vlan"
delete:
tags:
- Network
- summary: delete an existing entitlement
- description: delete an existing entitlement
- operationId: deleteNetworkVcesVceEntitlementsEntitlement
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: group-uuid
+ - name: interface-name
in: path
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ description: Name that identifies the physical interface
required: true
type: string
- - name: resource-uuid
+ - name: interface-name
in: path
- description: Unique ID of an entitlement resource.
+ 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
description: resource-version for concurrency
required: true
type: string
- /network/vces/vce/{vnf-id}/entitlements:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
get:
tags:
- Network
- summary: returns entitlements
- description: returns entitlements
- operationId: getNetworkVcesVceEntitlements
+ summary: returns vlans
+ description: returns vlans
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/entitlements"
+ $ref: "#/definitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: service-id
+ - name: prov-status
in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- - name: regional-resource-zone
+ - name: prov-status
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
required: false
type: string
- - name: prov-status
+ - name: interface-id
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: ID of interface
required: false
type: string
- - name: heat-stack-id
+ - name: macaddr
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description: MAC address for the interface
required: false
type: string
- - name: vpe-id
+ - name: network-name
in: query
- description: Unique ID of VPE connected to this VCE.
+ description: Name of the network
required: false
type: string
- /network/vces/vce/{vnf-id}/relationship-list/relationship:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: createOrUpdateNetworkVcesVceRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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 physical 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
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVcesVceRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- /network/vces/vce/{vnf-id}:
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
get:
tags:
- Network
- summary: returns vce
- description: returns vce
- operationId: getNetworkVcesVce
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vce"
+ $ref: "#/definitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: vnf-name
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical 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: prov-status
in: query
- description: Name of VNF.
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- - name: vnf-name2
+ - name: prov-status
in: query
- description: Alternate name of VNF.
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
required: false
type: string
- - name: vnf-type
+ - name: interface-id
in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ description: ID of interface
required: false
type: string
- - name: service-id
+ - name: macaddr
in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ description: MAC address for the interface
required: false
type: string
- - name: regional-resource-zone
+ - name: network-name
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Name of the network
required: false
type: string
- - name: prov-status
+ - name: vf-vlan-filter
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ 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: heat-stack-id
+ - name: vf-mac-filter
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ 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: vpe-id
+ - name: vf-vlan-strip
in: query
- description: Unique ID of VPE connected to this VCE.
+ 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 vce
- description: create or update an existing vce
- operationId: createOrUpdateNetworkVcesVce
+ summary: create or update an existing sriov-vf
+ description: create or update an existing sriov-vf
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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 physical 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: vce object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/vce"
+ $ref: "#/definitions/sriov-vf"
delete:
tags:
- Network
- summary: delete an existing vce
- description: delete an existing vce
- operationId: deleteNetworkVcesVce
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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 physical 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
description: resource-version for concurrency
required: true
type: string
- /network/vces:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
get:
tags:
- Network
- summary: returns vces
- description: returns vces
- operationId: getNetworkVces
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vces"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/vpes/vpe/{vnf-id}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
+ $ref: "#/definitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeRelationshipListRelationship
- 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
+ type: string
+ - name: interface-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Name given to the interface
required: true
type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ 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: 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: l3-interface-ipv4-address
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: l3-interface-ipv4-address
description: IP address
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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: getNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
produces:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: l3-interface-ipv4-address
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
+ - name: prov-status
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- name: prov-status
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: integer
format: int64
- - name: vpn-key
- 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
- 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
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: l3-interface-ipv4-address
- Network
summary: delete an existing l3-interface-ipv4-address-list
description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: l3-interface-ipv4-address
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-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: l3-interface-ipv6-address
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: l3-interface-ipv6-address
description: IP address
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}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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: getNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: l3-interface-ipv6-address
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
+ - name: prov-status
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- name: prov-status
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: integer
format: int64
- - name: vpn-key
- 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
- 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
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: l3-interface-ipv6-address
- Network
summary: delete an existing l3-interface-ipv6-address-list
description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: l3-interface-ipv6-address
description: resource-version for concurrency
required: true
type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
get:
tags:
- Network
- summary: returns vlan
- description: returns vlan
- operationId: getNetworkVpesVpeLInterfacesLInterfaceVlansVlan
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/definitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
+ - name: prov-status
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- name: prov-status
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
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-key
- 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
+ summary: create or update an existing l-interface
+ description: create or update an existing l-interface
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: l-interface object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/definitions/l-interface"
delete:
tags:
- Network
- summary: delete an existing vlan
- description: delete an existing vlan
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlan
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name given to the interface
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
get:
tags:
- Network
- summary: returns vlans
- description: returns vlans
- operationId: getNetworkVpesVpeLInterfacesLInterfaceVlans
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/definitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
+ - name: prov-status
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- name: prov-status
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
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns p-interface
+ description: returns p-interface
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/p-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
type: string
- - name: macaddr
+ - name: prov-status
in: query
- description: MAC address for the interface
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- - name: network-name
+ - name: prov-status
in: query
- description: Name of the network
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
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
+ summary: create or update an existing p-interface
+ description: create or update an existing p-interface
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: p-interface object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/p-interface"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ summary: delete an existing p-interface
+ description: delete an existing p-interface
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
+ - 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/sriov-vf/{pci-id}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
get:
tags:
- Network
- summary: returns sriov-vf
- description: returns sriov-vf
- operationId: getNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVf
+ summary: returns p-interfaces
+ description: returns p-interfaces
+ operationId: getNetworkVplsPesVplsPePInterfaces
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/definitions/p-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 given to the interface
- required: true
- type: string
- - name: pci-id
+ - name: equipment-name
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- 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
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
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
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ in: path
+ description: Name that identifies the link aggregate interface
required: true
type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
- get:
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
tags:
- Network
- summary: returns sriov-vfs
- description: returns sriov-vfs
- operationId: getNetworkVpesVpeLInterfacesLInterfaceSriovVfs
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
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
+ - name: equipment-name
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
+ 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- 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:
+ /network/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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:
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/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: getNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
produces:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
+ - name: prov-status
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- - name: prov-status
+ - name: interface-id
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: ID of interface
required: false
type: string
- - name: heat-stack-id
+ - name: interface-role
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
required: false
type: string
- name: interface-id
required: false
type: integer
format: int64
+ - name: vpn-key
+ 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
- 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
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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
- Network
summary: delete an existing l3-interface-ipv4-address-list
description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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
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:
+ /network/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/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: getNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
+ - name: prov-status
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- - name: prov-status
+ - name: interface-id
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: ID of interface
required: false
type: string
- - name: heat-stack-id
+ - name: interface-role
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
required: false
type: string
- name: interface-id
required: false
type: integer
format: int64
+ - name: vpn-key
+ 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
- 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
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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
- Network
summary: delete an existing l3-interface-ipv6-address-list
description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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
description: resource-version for concurrency
required: true
type: string
- /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
get:
tags:
- Network
- summary: returns l-interface
- description: returns l-interface
- operationId: getNetworkVpesVpeLInterfacesLInterface
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/definitions/vlan"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- required: false
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: regional-resource-zone
+ - name: prov-status
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- - name: prov-status
+ - name: interface-id
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: ID of interface
required: false
type: string
- - name: heat-stack-id
+ - name: interface-role
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
required: false
type: string
- name: interface-id
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-key
+ 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 l-interface
- description: create or update an existing l-interface
- operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterface
+ summary: create or update an existing vlan
+ description: create or update an existing vlan
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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: l-interface object that needs to be created or updated
+ description: vlan object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/definitions/vlan"
delete:
tags:
- Network
- summary: delete an existing l-interface
- description: delete an existing l-interface
- operationId: deleteNetworkVpesVpeLInterfacesLInterface
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
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:
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
get:
tags:
- Network
- summary: returns l-interfaces
- description: returns l-interfaces
- operationId: getNetworkVpesVpeLInterfaces
+ summary: returns vlans
+ description: returns vlans
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/definitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
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
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vnf-type
+ - name: prov-status
in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- - name: service-id
+ - name: interface-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: ID of interface
required: false
type: string
- - name: regional-resource-zone
+ - name: interface-role
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
required: false
type: string
- - name: prov-status
+ - name: interface-id
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: ID of interface
required: false
type: string
- - name: heat-stack-id
+ - name: macaddr
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description: MAC address for the interface
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:
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/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: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceRelationshipListRelationship
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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:
+ - 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: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
description: Name given to the interface
required: true
type: string
- - name: vlan-interface
+ - name: pci-id
in: path
- description: String that identifies the interface
+ 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:
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
+ get:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
description: Name given to the interface
required: true
type: string
- - name: vlan-interface
+ - name: pci-id
in: path
- description: String that identifies the interface
+ 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ 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: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ summary: create or update an existing sriov-vf
+ description: create or update an existing sriov-vf
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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
+ - name: pci-id
in: path
- description: IP address
+ 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
+ description: sriov-vf object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/sriov-vf"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
description: Name given to the interface
required: true
type: string
- - name: vlan-interface
+ - name: pci-id
in: path
- description: String that identifies the interface
+ description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
+ - 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-ipv4-address-list/{l3-interface-ipv4-address}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
get:
tags:
- Network
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/definitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- 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
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- name: interface-id
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-key
- 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
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
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
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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:
+ /network/vpls-pes/vpls-pe/{equipment-name}/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: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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
+ - name: l3-interface-ipv4-address
in: path
description: IP address
required: true
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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
+ - 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-ipv6-address-list/{l3-interface-ipv6-address}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/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-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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
+ - 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- 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
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- name: interface-id
required: false
type: integer
format: int64
- - name: vpn-key
- 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
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
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: create or update an existing l3-interface-ipv4-address-list
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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
+ - name: l3-interface-ipv4-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
+ description: l3-interface-ipv4-address-list object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/l3-interface-ipv4-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
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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
+ - name: l3-interface-ipv4-address
in: path
description: IP address
required: true
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- 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: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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-key
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/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: create or update an existing vlan
- description: create or update an existing vlan
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
description: Name given to the interface
required: true
type: string
- - name: vlan-interface
+ - name: l3-interface-ipv6-address
in: path
- description: String that identifies the interface
+ description: IP address
required: true
type: string
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
- summary: delete an existing vlan
- description: delete an existing vlan
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
description: Name given to the interface
required: true
type: string
- - name: vlan-interface
+ - name: l3-interface-ipv6-address
in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ 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:
+ /network/vpls-pes/vpls-pe/{equipment-name}/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 vlans
- description: returns vlans
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
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
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- name: interface-id
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:
+ - 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: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: create or update an existing l3-interface-ipv6-address-list
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
description: Name given to the interface
required: true
type: string
- - name: pci-id
+ - name: l3-interface-ipv6-address
in: path
- description: PCI ID used to identify the sriov-vf
+ description: IP address
required: true
type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
description: Name given to the interface
required: true
type: string
- - name: pci-id
+ - name: l3-interface-ipv6-address
in: path
- description: PCI ID used to identify the sriov-vf
+ 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}/sriov-vfs/sriov-vf/{pci-id}:
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
get:
tags:
- Network
- summary: returns sriov-vf
- description: returns sriov-vf
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/definitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- 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
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- name: interface-id
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
+ summary: create or update an existing l-interface
+ description: create or update an existing l-interface
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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
+ description: l-interface object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/definitions/l-interface"
delete:
tags:
- Network
- summary: delete an existing sriov-vf
- description: delete an existing sriov-vf
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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:
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
get:
tags:
- Network
- summary: returns sriov-vfs
- description: returns sriov-vfs
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $ref: "#/definitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- 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
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- name: interface-id
description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
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:
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
+ get:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns lag-interface
+ description: returns lag-interface
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
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
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ put:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ summary: create or update an existing lag-interface
+ description: create or update an existing lag-interface
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
description: Name that identifies the link aggregate interface
required: true
type: string
- - name: interface-name
- in: path
- description: Name given to the interface
+ - name: body
+ in: body
+ description: lag-interface object that needs to be created or updated
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:
+ schema:
+ $ref: "#/definitions/lag-interface"
+ delete:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ summary: delete an existing lag-interface
+ description: delete an existing lag-interface
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: equipment-name
in: path
- description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- name: interface-name
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
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
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:
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
+ get:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns lag-interfaces
+ description: returns lag-interfaces
+ operationId: getNetworkVplsPesVplsPeLagInterfaces
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: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
+ - name: equipment-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
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
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}:
+ /network/vpls-pes/vpls-pe/{equipment-name}:
get:
tags:
- Network
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ summary: returns vpls-pe
+ description: returns vpls-pe
+ operationId: getNetworkVplsPesVplsPe
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/definitions/vpls-pe"
"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
+ - name: equipment-name
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- 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: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
required: false
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vpls-pe
+ description: create or update an existing vpls-pe
+ operationId: createOrUpdateNetworkVplsPesVplsPe
+ 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: equipment-name
+ in: path
+ required: true
type: string
- put:
+ - name: body
+ in: body
+ description: vpls-pe object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/vpls-pe"
+ delete:
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
+ summary: delete an existing vpls-pe
+ description: delete an existing vpls-pe
+ operationId: deleteNetworkVplsPesVplsPe
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: equipment-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
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
type: string
- - name: l3-interface-ipv4-address
+ /network/vpls-pes:
+ get:
+ tags:
+ - Network
+ summary: returns vpls-pes
+ description: returns vpls-pes
+ operationId: getNetworkVplsPes
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vpls-pes"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
+ 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: multicast-configuration-id
in: path
- description: IP address
+ description: Unique id of multicast configuration.
required: true
type: string
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: multicast-configuration-id
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique id of multicast configuration.
required: true
type: string
- - name: interface-name
+ /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
+ get:
+ tags:
+ - Network
+ summary: returns multicast-configuration
+ description: returns multicast-configuration
+ operationId: getNetworkMulticastConfigurationsMulticastConfiguration
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/multicast-configuration"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: multicast-configuration-id
in: path
- description: Name that identifies the link aggregate interface
+ description: Unique id of multicast configuration.
required: true
type: string
- - name: interface-name
+ put:
+ tags:
+ - Network
+ summary: create or update an existing multicast-configuration
+ description: create or update an existing multicast-configuration
+ operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
+ 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: multicast-configuration-id
in: path
- description: Name given to the interface
+ description: Unique id of multicast configuration.
required: true
type: string
- - name: l3-interface-ipv4-address
+ - name: body
+ in: body
+ description: multicast-configuration object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/multicast-configuration"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing multicast-configuration
+ description: delete an existing multicast-configuration
+ operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
+ 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: multicast-configuration-id
in: path
- description: IP address
+ description: Unique id of multicast configuration.
required: true
type: string
- name: resource-version
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:
+ /network/multicast-configurations:
+ get:
+ tags:
+ - Network
+ summary: returns multicast-configurations
+ description: returns multicast-configurations
+ operationId: getNetworkMulticastConfigurations
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/multicast-configurations"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
consumes:
- application/json
- application/xml
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
+ - name: interface-id
in: path
- description: Name given to the interface
+ description: Unique ID of the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: cvlan-tag
in: path
- description: IP address
+ description: See mis-na-virtualization-platform.yang
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: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
consumes:
- application/json
- application/xml
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
+ - name: interface-id
in: path
- description: Name given to the interface
+ description: Unique ID of the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: cvlan-tag
in: path
- description: IP address
+ description: See mis-na-virtualization-platform.yang
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}:
+ type: integer
+ format: int64
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
get:
tags:
- Network
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: returns cvlan-tag-entry
+ description: returns cvlan-tag-entry
+ operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/cvlan-tag-entry"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
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
+ - name: interface-id
in: path
- description: Name given to the interface
+ description: Unique ID of the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: cvlan-tag
in: path
- description: IP address
+ description: See mis-na-virtualization-platform.yang
required: true
- type: string
+ type: integer
+ format: int64
- name: vnf-name
in: query
description: Name of VNF.
type: string
- name: service-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
required: false
type: string
- name: regional-resource-zone
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: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
+ - name: vpe-id
in: query
- description: MAC address for the interface
+ description: Unique ID of VPE connected to this VCE.
required: false
type: string
- - name: network-name
+ - name: port-group-id
in: query
- description: Name of the network
+ description: Unique ID for port group in vmware
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: switch-name
in: query
- description: Neutron network id of the interface that address belongs to
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
required: false
type: string
- - name: neutron-subnet-id
+ - name: heat-stack-id
in: query
- description: Neutron id of subnet that address belongs to
+ description: Heat stack id corresponding to this instance, managed by MSO
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
+ summary: create or update an existing cvlan-tag-entry
+ description: create or update an existing cvlan-tag-entry
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
consumes:
- application/json
- application/xml
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
+ - name: interface-id
in: path
- description: Name given to the interface
+ description: Unique ID of the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: cvlan-tag
in: path
- description: IP address
+ description: See mis-na-virtualization-platform.yang
required: true
- type: string
+ type: integer
+ format: int64
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: cvlan-tag-entry object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/cvlan-tag-entry"
delete:
tags:
- Network
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: delete an existing cvlan-tag-entry
+ description: delete an existing cvlan-tag-entry
+ operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
consumes:
- application/json
- application/xml
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
+ - name: interface-id
in: path
- description: Name given to the interface
+ description: Unique ID of the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ - name: cvlan-tag
in: path
- description: IP address
+ description: See mis-na-virtualization-platform.yang
required: true
- type: string
+ type: integer
+ format: int64
- 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}:
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
get:
tags:
- Network
- summary: returns l-interface
- description: returns l-interface
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface
+ summary: returns cvlan-tags
+ description: returns cvlan-tags
+ operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/definitions/cvlan-tags"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
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
+ - name: interface-id
in: path
- description: Name given to the interface
+ description: Unique ID of the interface
required: true
type: string
- name: vnf-name
type: string
- name: service-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
required: false
type: string
- name: regional-resource-zone
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: interface-role
+ - name: vpe-id
in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ description: Unique ID of VPE connected to this VCE.
required: false
type: string
- - name: interface-id
+ - name: port-group-id
in: query
- description: ID of interface
+ description: Unique ID for port group in vmware
required: false
type: string
- - name: macaddr
+ - name: switch-name
in: query
- description: MAC address for the interface
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
required: false
type: string
- - name: network-name
+ - name: heat-stack-id
in: query
- description: Name of the network
+ description: Heat stack id corresponding to this instance, managed by MSO
required: false
type: string
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
put:
tags:
- Network
- summary: create or update an existing l-interface
- description: create or update an existing l-interface
- operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
consumes:
- application/json
- application/xml
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
+ - name: interface-id
in: path
- description: Name given to the interface
+ description: Unique ID of the interface
required: true
type: string
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
- summary: delete an existing l-interface
- description: delete an existing l-interface
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
consumes:
- application/json
- application/xml
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
+ - name: interface-id
in: path
- description: Name given to the interface
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ description: Unique ID of the interface
required: true
type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
get:
tags:
- Network
- summary: returns l-interfaces
- description: returns l-interfaces
- operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfaces
+ summary: returns port-group
+ description: returns port-group
+ operationId: getNetworkVcesVcePortGroupsPortGroup
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/definitions/port-group"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-name
+ - name: interface-id
in: path
- description: Name that identifies the link aggregate interface
+ description: Unique ID of the interface
required: true
type: string
- name: vnf-name
type: string
- name: service-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
required: false
type: string
- name: regional-resource-zone
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: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
- - name: service-id
+ - name: vpe-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: Unique ID of VPE connected to this VCE.
required: false
type: string
- - name: regional-resource-zone
+ - name: port-group-id
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description: Unique ID for port group in vmware
required: false
type: string
- - name: prov-status
+ - name: switch-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
required: false
type: string
- name: heat-stack-id
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: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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
+ summary: create or update an existing port-group
+ description: create or update an existing port-group
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-name
+ - name: interface-id
in: path
- description: Name that identifies the link aggregate interface
+ description: Unique ID of the interface
required: true
type: string
- name: body
in: body
- description: lag-interface object that needs to be created or updated
+ description: port-group object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/lag-interface"
+ $ref: "#/definitions/port-group"
delete:
tags:
- Network
- summary: delete an existing lag-interface
- description: delete an existing lag-interface
- operationId: deleteNetworkVpesVpeLagInterfacesLagInterface
+ summary: delete an existing port-group
+ description: delete an existing port-group
+ operationId: deleteNetworkVcesVcePortGroupsPortGroup
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-name
+ - name: interface-id
in: path
- description: Name that identifies the link aggregate interface
+ description: Unique ID of the interface
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/vpes/vpe/{vnf-id}/lag-interfaces:
+ /network/vces/vce/{vnf-id}/port-groups:
get:
tags:
- Network
- summary: returns lag-interfaces
- description: returns lag-interfaces
- operationId: getNetworkVpesVpeLagInterfaces
+ summary: returns port-groups
+ description: returns port-groups
+ operationId: getNetworkVcesVcePortGroups
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-interfaces"
+ $ref: "#/definitions/port-groups"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
type: string
- name: service-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
required: false
type: string
- name: regional-resource-zone
description: Heat stack id corresponding to this instance, managed by MSO
required: false
type: string
- /network/vpes/vpe/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeLicensesLicenseRelationshipListRelationship
+ operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
consumes:
- application/json
- application/xml
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeLicensesLicenseRelationshipListRelationship
+ operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique ID of a license resource.
required: true
type: string
- /network/vpes/vpe/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
+ /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
get:
tags:
- Network
summary: returns license
description: returns license
- operationId: getNetworkVpesVpeLicensesLicense
+ operationId: getNetworkVcesVceLicensesLicense
produces:
- application/json
- application/xml
type: string
- name: service-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
required: false
type: string
- name: regional-resource-zone
description: Heat stack id corresponding to this instance, managed by MSO
required: false
type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
put:
tags:
- Network
summary: create or update an existing license
description: create or update an existing license
- operationId: createOrUpdateNetworkVpesVpeLicensesLicense
+ operationId: createOrUpdateNetworkVcesVceLicensesLicense
consumes:
- application/json
- application/xml
- Network
summary: delete an existing license
description: delete an existing license
- operationId: deleteNetworkVpesVpeLicensesLicense
+ operationId: deleteNetworkVcesVceLicensesLicense
consumes:
- application/json
- application/xml
description: resource-version for concurrency
required: true
type: string
- /network/vpes/vpe/{vnf-id}/licenses:
+ /network/vces/vce/{vnf-id}/licenses:
get:
tags:
- Network
summary: returns licenses
description: returns licenses
- operationId: getNetworkVpesVpeLicenses
+ operationId: getNetworkVcesVceLicenses
produces:
- application/json
- application/xml
type: string
- name: service-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
required: false
type: string
- name: regional-resource-zone
description: Heat stack id corresponding to this instance, managed by MSO
required: false
type: string
- /network/vpes/vpe/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpesVpeEntitlementsEntitlementRelationshipListRelationship
+ operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
consumes:
- application/json
- application/xml
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVpesVpeEntitlementsEntitlementRelationshipListRelationship
+ operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique ID of an entitlement resource.
required: true
type: string
- /network/vpes/vpe/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
+ /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
get:
tags:
- Network
summary: returns entitlement
description: returns entitlement
- operationId: getNetworkVpesVpeEntitlementsEntitlement
+ operationId: getNetworkVcesVceEntitlementsEntitlement
produces:
- application/json
- application/xml
type: string
- name: service-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
required: false
type: string
- name: regional-resource-zone
description: Heat stack id corresponding to this instance, managed by MSO
required: false
type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
put:
tags:
- Network
summary: create or update an existing entitlement
description: create or update an existing entitlement
- operationId: createOrUpdateNetworkVpesVpeEntitlementsEntitlement
+ operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
consumes:
- application/json
- application/xml
- Network
summary: delete an existing entitlement
description: delete an existing entitlement
- operationId: deleteNetworkVpesVpeEntitlementsEntitlement
+ operationId: deleteNetworkVcesVceEntitlementsEntitlement
consumes:
- application/json
- application/xml
description: resource-version for concurrency
required: true
type: string
- /network/vpes/vpe/{vnf-id}/entitlements:
+ /network/vces/vce/{vnf-id}/entitlements:
get:
tags:
- Network
summary: returns entitlements
description: returns entitlements
- operationId: getNetworkVpesVpeEntitlements
+ operationId: getNetworkVcesVceEntitlements
produces:
- application/json
- application/xml
type: string
- name: service-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
required: false
type: string
- name: regional-resource-zone
description: Heat stack id corresponding to this instance, managed by MSO
required: false
type: string
- /network/vpes/vpe/{vnf-id}:
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ /network/vces/vce/{vnf-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
+ 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: 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: deleteNetworkVcesVceRelationshipListRelationship
+ 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
+ /network/vces/vce/{vnf-id}:
get:
tags:
- Network
- summary: returns vpe
- description: returns vpe
- operationId: getNetworkVpesVpe
+ summary: returns vce
+ description: returns vce
+ operationId: getNetworkVcesVce
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vpe"
+ $ref: "#/definitions/vce"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
type: string
- name: service-id
in: query
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
required: false
type: string
- name: regional-resource-zone
description: Heat stack id corresponding to this instance, managed by MSO
required: false
type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
put:
tags:
- Network
- summary: create or update an existing vpe
- description: create or update an existing vpe
- operationId: createOrUpdateNetworkVpesVpe
+ summary: create or update an existing vce
+ description: create or update an existing vce
+ operationId: createOrUpdateNetworkVcesVce
consumes:
- application/json
- application/xml
type: string
- name: body
in: body
- description: vpe object that needs to be created or updated
+ description: vce object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/vpe"
+ $ref: "#/definitions/vce"
delete:
tags:
- Network
- summary: delete an existing vpe
- description: delete an existing vpe
- operationId: deleteNetworkVpesVpe
+ summary: delete an existing vce
+ description: delete an existing vce
+ operationId: deleteNetworkVcesVce
consumes:
- application/json
- application/xml
description: resource-version for concurrency
required: true
type: string
- /network/vpes:
+ /network/vces:
get:
tags:
- Network
- summary: returns vpes
- description: returns vpes
- operationId: getNetworkVpes
+ summary: returns vces
+ description: returns vces
+ operationId: getNetworkVces
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vpes"
+ $ref: "#/definitions/vces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
/network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
description: Unique ID of vnfc.
required: true
type: string
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
+ 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: 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: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
+ 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: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /network/vnfcs/vnfc/{vnfc-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: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ 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: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: nfc-naming-code
+ in: query
+ description: Short code that is used in naming instances of the item being modeled
+ required: false
+ type: string
+ - name: nfc-function
+ in: query
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ 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
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ 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
+ 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: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ 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: 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: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ 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: 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/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
+ 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: 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: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
+ 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: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /network/vnfcs/vnfc/{vnfc-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: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ 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: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: nfc-naming-code
+ in: query
+ description: Short code that is used in naming instances of the item being modeled
+ required: false
+ type: string
+ - name: nfc-function
+ in: query
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ 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
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ 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
+ 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: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ 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: 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: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ 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: 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/vnfcs/vnfc/{vnfc-name}:
get:
tags:
$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}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
+ 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: host-route-id
+ in: path
+ description: host-route id
+ 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: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
+ 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: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
+ get:
+ tags:
+ - Network
+ summary: returns host-route
+ description: returns host-route
+ operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/host-route"
+ "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: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ 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: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ 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 host-route
+ description: create or update an existing host-route
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ 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: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: host-route object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/host-route"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing host-route
+ description: delete an existing host-route
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ 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: host-route-id
+ in: path
+ description: host-route id
+ 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/subnet/{subnet-id}/host-routes:
+ get:
+ tags:
+ - Network
+ summary: returns host-routes
+ description: returns host-routes
+ operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/host-routes"
+ "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: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ 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: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ 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
/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
put:
tags:
ctag-pool:
description: |
A collection of C tags (vlan tags) grouped for a specific purpose.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO availability-zone (Many2Many)
- FROM complex (is composed of ctag-pool)
- - FROM vpe
- FROM vpls-pe
- FROM generic-vnf
required:
complex:
description: |
Collection of physical locations that can house cloud-regions.
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO ctag-pool (comprises complex, Many2Many)
- TO l3-network (Many2Many)
- FROM pserver
- FROM pnf
- FROM vce
- - FROM vpe
- FROM vpls-pe
- FROM volume-group
- FROM zone
volume-group:
description: |
Persistent block-level storage.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO complex (Many2Many)
- TO tenant (Many2Many)
volume:
description: |
Ephemeral Block storage volume.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM vserver (is composed of volume)
required:
l3-interface-ipv4-address-list:
description: |
IPv4 Address Range
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO instance-group (Many2Many)
- TO l3-network (Many2Many)
- TO subnet (Many2Many)
+ - TO vnfc (is composed of l3-interface-ipv4-address-list, Many2One)
- FROM l-interface (is composed of l3-interface-ipv4-address-list)
- FROM vlan (is composed of l3-interface-ipv4-address-list)
required:
l3-interface-ipv6-address-list:
description: |
IPv6 Address Range
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO instance-group (Many2Many)
- TO l3-network (Many2Many)
- TO subnet (Many2Many)
+ - TO vnfc (is composed of l3-interface-ipv6-address-list, Many2One)
- FROM l-interface (is composed of l3-interface-ipv6-address-list)
- FROM vlan (is composed of l3-interface-ipv6-address-list)
required:
vlan:
description: |
Definition of vlan
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO l3-interface-ipv4-address-list (comprises vlan, Many2Many)
- TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
- TO multicast-configuration (Many2Many)
- - TO logical-link (Many2Many, will delete target node)
+ - TO logical-link (Many2Many)
- FROM l-interface (is composed of vlan)
- FROM service-instance
- FROM allotted-resource
required:
- vlan-interface
- in-maint
+ - is-ip-unnumbered
properties:
vlan-interface:
type: string
prov-status:
type: string
description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
+ is-ip-unnumbered:
+ type: boolean
relationship-list:
type: array
items:
sriov-vf:
description: |
SR-IOV Virtual Function (not to be confused with virtual network function)
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO sriov-pf (Many2One)
- FROM l-interface (is composed of sriov-vf)
l-interface:
description: |
Logical interfaces, e.g., a vnic.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO instance-group (Many2Many)
- TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
- TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
- TO l-interface (comprises l-interface, One2Many)
- - 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 vpe (is composed of l-interface)
- FROM vserver (is composed of l-interface)
- FROM allotted-resource
- FROM l-interface (is composed of l-interface)
- interface-name
- is-port-mirrored
- in-maint
+ - is-ip-unnumbered
properties:
interface-name:
type: string
prov-status:
type: string
description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
+ is-ip-unnumbered:
+ type: boolean
+ allowed-address-pairs:
+ type: string
+ description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
vlans:
type: array
items:
vserver:
description: |
Virtual Servers, aka virtual machine or VM.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### 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)
- FROM generic-vnf
- FROM tenant (is composed of vserver)
- FROM vce
- - FROM vpe
required:
- vserver-id
- vserver-name
tenant:
description: |
Openstack tenant
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO l3-network (Many2Many)
- TO service-subscription (Many2Many)
tenant-name:
type: string
description: Readable name of tenant
+ tenant-context:
+ type: string
+ description: This field will store the tenant context.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
flavor:
description: |
Openstack flavor.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- FROM cloud-region (is composed of flavor)
- FROM vserver
group-assignment:
description: |
Openstack group-assignment used to store exclusivity groups (EG).
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO tenant (Many2Many)
- TO pserver (One2Many)
snapshot:
description: |
Openstack snapshot
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM cloud-region (is composed of snapshot)
- FROM vserver
metadatum:
description: |
Key/value pairs
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
+ - FROM configuration (is composed of metadatum)
- FROM image (is composed of metadatum)
- FROM model-ver (is composed of metadatum)
- FROM service-instance (is composed of metadatum)
metadata:
description: |
Collection of metadatum (key/value pairs)
- ###### Default Delete Scope
- THIS_NODE_ONLY
- ###### Related Nodes
- - FROM image (is composed of metadata)
properties:
metadatum:
type: array
image:
description: |
Openstack image.
- ###### 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.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO availability-zone (Many2Many)
- FROM cloud-region (is composed of dvs-switch)
$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.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- TO complex (Many2Many)
- TO service-capability (Many2Many)
availability-zone:
description: |
Availability zone, a collection of compute hosts/pservers
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- TO complex (Many2Many)
- TO service-capability (Many2Many)
type: array
items:
$ref: "#/definitions/availability-zone"
+ esr-system-info:
+ description: |
+ Persist common address information of external systems.
+ ###### Related Nodes
+ - FROM esr-ems (is composed of esr-system-info)
+ - FROM esr-vnfm (is composed of esr-system-info)
+ - FROM esr-thirdparty-sdnc (is composed of esr-system-info)
+ - FROM cloud-region (is composed of esr-system-info)
+ required:
+ - esr-system-info-id
+ - user-name
+ - password
+ - system-type
+ properties:
+ esr-system-info-id:
+ type: string
+ description: Unique ID of esr system info.
+ system-name:
+ type: string
+ description: name of external system.
+ type:
+ type: string
+ description: type of external systems.
+ vendor:
+ type: string
+ description: vendor of external systems.
+ version:
+ type: string
+ description: version of external systems.
+ service-url:
+ type: string
+ description: url used to access external systems.
+ user-name:
+ type: string
+ description: username used to access external systems.
+ password:
+ type: string
+ description: password used to access external systems.
+ system-type:
+ type: string
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ protocol:
+ type: string
+ description: protocol of third party SDNC, for example netconf/snmp.
+ ssl-cacert:
+ type: string
+ description: ca file content if enabled ssl on auth-url.
+ ssl-insecure:
+ type: boolean
+ description: Whether to verify VIM's certificate.
+ ip-address:
+ type: string
+ description: service IP of ftp server.
+ port:
+ type: string
+ description: service port of ftp server.
+ cloud-domain:
+ type: string
+ description: domain info for authentication.
+ default-tenant:
+ type: string
+ description: default tenant of VIM.
+ passive:
+ type: boolean
+ description: ftp passive mode or not.
+ remote-path:
+ type: string
+ description: resource or performance data file path.
+ system-status:
+ type: string
+ description: the status of external system.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ esr-system-info-list:
+ description: |
+ Collection of persistent block-level external system auth info.
+ properties:
+ esr-system-info:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ vip-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO instance-group (Many2Many)
+ - TO subnet (Many2Many)
+ - FROM vnfc
+ - FROM cloud-region (is composed of vip-ipv4-address-list)
+ required:
+ - vip-ipv4-address
+ properties:
+ vip-ipv4-address:
+ type: string
+ description: IP address
+ vip-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vip-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO instance-group (Many2Many)
+ - TO subnet (Many2Many)
+ - FROM vnfc
+ - FROM cloud-region (is composed of vip-ipv6-address-list)
+ required:
+ - vip-ipv6-address
+ properties:
+ vip-ipv6-address:
+ type: string
+ description: IP address
+ vip-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
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.
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
###### Related Nodes
+ - TO esr-system-info (comprises cloud-region, One2Many)
- TO complex (Many2One)
- TO l3-network (Many2Many)
- TO tenant (comprises cloud-region, One2Many)
- TO group-assignment (comprises cloud-region, One2Many)
- TO snapshot (comprises cloud-region, One2Many)
- TO zone (Many2One)
+ - TO vip-ipv4-address-list (comprises cloud-region, One2Many)
+ - TO vip-ipv6-address-list (comprises cloud-region, One2Many)
- FROM pserver
- FROM logical-link
required:
properties:
cloud-owner:
type: string
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id:
type: string
description: Identifier used by the vendor for the region. Second part of composite key
description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
sriov-automation:
type: boolean
+ cloud-extra-info:
+ type: string
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ vip-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/vip-ipv4-address-list"
+ vip-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/vip-ipv6-address-list"
cloud-regions:
properties:
cloud-region:
network-profile:
description: |
Network profile populated by SDN-GP for SNMP
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM generic-vnf
required:
sriov-pf:
description: |
SR-IOV Physical Function
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM p-interface (is composed of sriov-pf)
- FROM sriov-vf
p-interface:
description: |
Physical interface (e.g., nic)
- ###### Default Delete Scope
- 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)
- TO sriov-pf (comprises p-interface, One2One)
- FROM lag-interface
prov-status:
type: string
description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
lag-interface:
description: |
Link aggregate interface
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- - TO logical-link (Many2Many, will delete target node)
- - TO lag-link (Many2Many, will delete target node)
+ - TO logical-link (Many2Many)
+ - 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 vpe (is composed of lag-interface)
- FROM vpls-pe (is composed of lag-interface)
required:
- interface-name
pserver:
description: |
Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO complex (Many2One)
- TO cloud-region (Many2One)
virtual-data-center:
description: |
Virtual organization of cloud infrastructure elements in a data center context
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO generic-vnf (Many2Many)
- TO logical-link (Many2Many)
type: array
items:
$ref: "#/definitions/virtual-data-center"
- license-key-resource:
+ esr-ems:
description: |
- OBSOLETE OBJECT: do not use
+ Persist EMS address information used by EMS driver.
###### Related Nodes
- - FROM generic-vnf
+ - TO esr-system-info (comprises esr-ems, One2Many)
required:
- - att-uuid
- - assignment-group-uuid
+ - ems-id
properties:
- att-uuid:
- type: string
- assignment-type:
+ ems-id:
type: string
- assignment-status:
- type: string
- assignment-group-uuid:
+ description: Unique ID of EMS.
+ resource-version:
type: string
- assignment-date:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ esr-ems-list:
+ properties:
+ esr-ems:
+ type: array
+ items:
+ $ref: "#/definitions/esr-ems"
+ esr-vnfm:
+ description: |
+ Persist VNFM address information used by VF-C.
+ ###### Related Nodes
+ - TO esr-system-info (comprises esr-vnfm, One2One)
+ required:
+ - vnfm-id
+ properties:
+ vnfm-id:
type: string
- name:
+ description: Unique ID of VNFM.
+ vim-id:
type: string
- model-uuid:
+ description: indecate the VIM to deploy VNF.
+ certificate-url:
type: string
- model-version:
+ description: certificate url of VNFM.
+ resource-version:
type: string
- license-key:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ esr-vnfm-list:
+ properties:
+ esr-vnfm:
+ type: array
+ items:
+ $ref: "#/definitions/esr-vnfm"
+ esr-thirdparty-sdnc:
+ description: |
+ Persist SDNC address information used by ONAP SDNC.
+ ###### Related Nodes
+ - TO esr-system-info (comprises esr-thirdparty-sdnc, One2One)
+ - TO pnf (One2Many)
+ required:
+ - thirdparty-sdnc-id
+ properties:
+ thirdparty-sdnc-id:
type: string
- license-key-file-url:
+ description: Unique ID of SDNC.
+ location:
type: string
- supplier-release-list:
+ description: used for DC type to indicate the location of SDNC, such as Core or Edge.
+ product-name:
type: string
+ description: password used to access SDNC server.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- license-key-resources:
+ esr-thirdparty-sdnc-list:
properties:
- license-key-resource:
+ esr-thirdparty-sdnc:
type: array
items:
- $ref: "#/definitions/license-key-resource"
- license-management:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ external-system:
+ description: |
+ Namespace for external system.
properties:
- license-key-resources:
+ esr-ems-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-ems"
+ esr-vnfm-list:
type: array
items:
- $ref: "#/definitions/license-key-resource"
+ $ref: "#/definitions/esr-vnfm"
+ esr-thirdparty-sdnc-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
connector:
description: |
Collection of resource instances used to connect a variety of disparate inventory widgets
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO virtual-data-center (Many2Many)
- TO metadatum (comprises connector, Many2Many)
tunnel-xconnect:
description: |
Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM allotted-resource (is composed of tunnel-xconnect)
required:
allotted-resource:
description: |
Represents a slice or partial piece of a resource that gets separately allotted
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO generic-vnf (Many2Many)
- TO l3-network (Many2Many)
- TO l-interface (One2Many)
- TO tunnel-xconnect (comprises allotted-resource, One2One)
- TO vpn-binding (Many2Many)
+ - TO allotted-resource (One2One)
+ - FROM configuration
- FROM service-instance (is composed of allotted-resource)
- FROM service-instance
+ - FROM allotted-resource
required:
- id
properties:
service-instance:
description: |
Instance of a service
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
+ - TO configuration (One2Many)
- TO zone (Many2One)
- TO cvlan-tag (Many2Many)
- TO pnf (One2Many)
- 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)
- TO ctag-assignment (One2Many)
- TO allotted-resource (Many2Many)
- FROM generic-vnf
- FROM l3-network
+ - FROM owning-entity
+ - FROM project
- FROM service-subscription (is composed of service-instance)
- FROM vce
- FROM service-instance
required:
- service-instance-id
+ - service-type
+ - service-role
properties:
service-instance-id:
type: string
service-instance-name:
type: string
description: This field will store a name assigned to the service-instance.
+ service-type:
+ type: string
+ description: String capturing type of service.
+ service-role:
+ type: string
+ description: String capturing the service role.
+ environment-context:
+ type: string
+ description: This field will store the environment context assigned to the service-instance.
+ workload-context:
+ type: string
+ description: This field will store the workload context assigned to the service-instance.
model-invariant-id:
type: string
description: the ASDC model id for this resource or service model.
service-subscription:
description: |
Object that group service instances.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO service-instance (comprises service-subscription, Many2Many)
- FROM customer (is composed of service-subscription)
customer:
description: |
customer identifiers to provide linkage back to BSS information.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO service-subscription (comprises customer, Many2Many)
required:
type: array
items:
$ref: "#/definitions/customer"
+ line-of-business:
+ description: |
+ describes a line-of-business
+ ###### Related Nodes
+ - TO generic-vnf (Many2Many)
+ required:
+ - line-of-business-name
+ properties:
+ line-of-business-name:
+ type: string
+ description: Name of the line-of-business (product)
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ lines-of-business:
+ description: |
+ Collection of lines-of-business
+ properties:
+ line-of-business:
+ type: array
+ items:
+ $ref: "#/definitions/line-of-business"
+ owning-entity:
+ description: |
+ describes an owning-entity
+ ###### Related Nodes
+ - TO service-instance (One2Many)
+ required:
+ - owning-entity-id
+ - owning-entity-name
+ properties:
+ owning-entity-id:
+ type: string
+ description: UUID of an owning entity
+ owning-entity-name:
+ type: string
+ description: Owning entity name
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ owning-entities:
+ description: |
+ Collection of owning-entities
+ properties:
+ owning-entity:
+ type: array
+ items:
+ $ref: "#/definitions/owning-entity"
+ platform:
+ description: |
+ describes a platform
+ ###### Related Nodes
+ - TO generic-vnf (Many2Many)
+ required:
+ - platform-name
+ properties:
+ platform-name:
+ type: string
+ description: Name of the platform
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ platforms:
+ description: |
+ Collection of platforms
+ properties:
+ platform:
+ type: array
+ items:
+ $ref: "#/definitions/platform"
+ project:
+ description: |
+ describes the project
+ ###### Related Nodes
+ - TO service-instance (One2Many)
+ required:
+ - project-name
+ properties:
+ project-name:
+ type: string
+ description: Name of the project deploying a service
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ projects:
+ description: |
+ Collection of projects
+ properties:
+ project:
+ type: array
+ items:
+ $ref: "#/definitions/project"
business:
description: |
Namespace for business related constructs
type: array
items:
$ref: "#/definitions/customer"
+ lines-of-business:
+ type: array
+ items:
+ $ref: "#/definitions/line-of-business"
+ owning-entities:
+ type: array
+ items:
+ $ref: "#/definitions/owning-entity"
+ platforms:
+ type: array
+ items:
+ $ref: "#/definitions/platform"
+ projects:
+ type: array
+ items:
+ $ref: "#/definitions/project"
vnf-image:
description: |
Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- FROM generic-vnf
required:
- - att-uuid
+ - vnf-image-uuid
- application
- application-vendor
properties:
- att-uuid:
+ vnf-image-uuid:
type: string
description: Unique ID of this asset
application:
service:
description: |
Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
required:
- service-id
- service-description
service-capability:
description: |
Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- FROM availability-zone
- FROM oam-network
element-choice-set:
description: |
This is how we would capture constraints defining allowed sets of elements.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO model-element (comprises element-choice-set, One2Many)
- FROM constrained-element-set (is composed of element-choice-set)
constrained-element-set:
description: |
This is how we would capture constraints defining allowed sets of elements.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO element-choice-set (comprises constrained-element-set, One2Many)
- FROM model-element (is composed of constrained-element-set)
model-constraint:
description: |
This is how we would capture constraints defining allowed sets of elements.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO constrained-element-set (comprises model-constraint, One2Many)
- FROM model-element (is composed of model-constraint)
model-element:
description: |
Defines how other models combine to make up a higher-level model.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO model-ver (Many2One)
- TO model-element (comprises model-element, One2Many)
model-ver:
description: |
Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO model-element (comprises model-ver, One2Many)
- TO metadatum (comprises model-ver, One2Many)
model:
description: |
Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO model-ver (comprises model, One2Many)
- FROM named-query
related-lookup:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- FROM named-query-element (is composed of related-lookup)
required:
property-constraint:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- FROM named-query-element (is composed of property-constraint)
required:
named-query-element:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO named-query-element (comprises named-query-element, Many2Many)
- TO model (Many2One)
named-query:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO model (One2Many)
- TO named-query-element (comprises named-query, One2One)
logical-link:
description: |
Logical links generally connect l-interfaces but are used to express logical connectivity between two points
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO lag-link (Many2Many)
- TO pnf (Many2Many)
- TO pserver (Many2Many)
- TO cloud-region (Many2Many)
- TO vpn-binding (Many2Many)
+ - FROM configuration
- FROM l-interface
- FROM lag-interface
- FROM p-interface
- FROM logical-link
required:
- link-name
+ - in-maint
- link-type
properties:
link-name:
type: string
description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ in-maint:
+ type: boolean
link-type:
type: string
description: Type of logical link, e.g., evc
description: Captures the units corresponding to the speed
ip-version:
type: string
- description: v4, v6, or ds for dual stack (should be att-ip-version)
+ description: v4, v6, or ds for dual stack
routing-protocol:
type: string
description: For example, static or BGP
$ref: "#/definitions/logical-link"
class-of-service:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM site-pair (is composed of class-of-service)
required:
$ref: "#/definitions/class-of-service"
site-pair:
description: |
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO class-of-service (comprises site-pair, Many2Many)
- FROM routing-instance (is composed of site-pair)
$ref: "#/definitions/site-pair"
routing-instance:
description: |
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO site-pair (comprises routing-instance, Many2Many)
- FROM site-pair-set (is composed of routing-instance)
site-pair-set:
description: |
Set of instances for probes used to measure service level agreements
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO routing-instance (comprises site-pair-set, Many2Many)
- FROM generic-vnf
route-target:
description: |
Route target information
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- FROM vpn-binding (is composed of route-target)
required:
vpn-binding:
description: |
VPN binding
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO route-target (comprises vpn-binding, One2Many)
- FROM l3-network
vpls-pe:
description: |
VPLS Provider Edge routers.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO complex (Many2Many)
- TO ctag-pool (Many2Many)
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.
$ref: "#/definitions/vpls-pe"
multicast-configuration:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM vlan
required:
port-group:
description: |
Used to capture the network interfaces of this VCE
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO cvlan-tag (comprises port-group, Many2Many)
- FROM vce (is composed of port-group)
license:
description: |
Metadata for license group.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM generic-vnf (is composed of license)
- FROM vce (is composed of license)
- - FROM vpe (is composed of license)
required:
- group-uuid
- resource-uuid
entitlement:
description: |
Metadata for entitlement group.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM generic-vnf (is composed of entitlement)
- FROM vce (is composed of entitlement)
- - FROM vpe (is composed of entitlement)
required:
- group-uuid
- resource-uuid
vce:
description: |
Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO availability-zone (Many2Many)
- TO complex (Many2Many)
type: array
items:
$ref: "#/definitions/vce"
- vpe:
- description: |
- Relationship-list must include related to info for complex.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
- ###### Related Nodes
- - TO complex (Many2Many)
- - TO ctag-pool (Many2Many)
- - TO l-interface (comprises vpe, Many2Many)
- - TO lag-interface (comprises vpe, Many2Many)
- - TO vserver (Many2Many)
- - TO entitlement (comprises vpe, One2Many)
- - TO license (comprises vpe, One2Many)
- 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- service-id:
- type: string
- description: Unique identifier of service. Does not map strictly to ASDC services. SOON TO BE DEPRECATED
- 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-status:
- type: string
- description: Indicator for whether the resource is considered operational
- license-key:
- type: string
- description: OBSOLETE - do not use. See child relationships.
- 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, PLEASE DISCONTINUE USE OF THIS FIELD.
- 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"
- licenses:
- type: array
- items:
- $ref: "#/definitions/license"
- entitlements:
- type: array
- items:
- $ref: "#/definitions/entitlement"
- 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
- THIS_NODE_ONLY
###### Related Nodes
- TO instance-group (Many2Many)
+ - TO vip-ipv4-address-list (Many2Many)
+ - TO vip-ipv6-address-list (Many2Many)
- FROM vserver
- FROM vf-module
- FROM generic-vnf
+ - FROM l3-interface-ipv4-address-list (comprises vnfc)
+ - FROM l3-interface-ipv6-address-list (comprises vnfc)
required:
- vnfc-name
- nfc-naming-code
type: array
items:
$ref: "#/definitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
vnfcs:
description: |
virtual network components associated with a vserver from application controller.
type: array
items:
$ref: "#/definitions/vnfc"
+ host-route:
+ description: |
+ ###### Related Nodes
+ - FROM subnet (is composed of host-route)
+ required:
+ - host-route-id
+ - route-prefix
+ - next-hop
+ properties:
+ host-route-id:
+ type: string
+ description: host-route id
+ route-prefix:
+ type: string
+ description: subnet prefix
+ next-hop:
+ type: string
+ description: Could be ip-address, hostname, or service-instance
+ next-hop-type:
+ type: string
+ description: Should be ip-address, hostname, or service-instance to match next-hop
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ host-routes:
+ properties:
+ host-route:
+ type: array
+ items:
+ $ref: "#/definitions/host-route"
subnet:
description: |
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
+ - TO host-route (comprises subnet, One2Many)
- FROM l3-interface-ipv4-address-list
- FROM l3-interface-ipv6-address-list
- FROM l3-network (is composed of subnet)
+ - FROM vip-ipv4-address-list
+ - FROM vip-ipv6-address-list
required:
- subnet-id
- dhcp-enabled
subnet-role:
type: string
description: role of the subnet, referenced when assigning IPs
+ ip-assignment-direction:
+ type: string
+ description: ip address assignment direction of the subnet
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ subnet-sequence:
+ type: integer
+ format: int32
+ description: sequence of the subnet
+ host-routes:
+ type: array
+ items:
+ $ref: "#/definitions/host-route"
relationship-list:
type: array
items:
$ref: "#/definitions/subnet"
ctag-assignment:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network (is composed of ctag-assignment)
- FROM service-instance
segmentation-assignment:
description: |
Openstack segmentation assignment.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network (is composed of segmentation-assignment)
required:
l3-network:
description: |
Generic network definition
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO vpn-binding (Many2Many)
- TO instance-group (Many2Many)
$ref: "#/definitions/l3-network"
network-policy:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network
- FROM allotted-resource
vf-module:
description: |
a deployment unit of VNFCs
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### 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:
generic-vnf:
description: |
General purpose VNF
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO license-key-resource (Many2Many)
- TO l-interface (comprises generic-vnf, Many2Many)
- TO network-profile (Many2Many)
- TO pnf (Many2Many)
- TO ipsec-configuration (Many2One)
+ - TO configuration (One2Many)
- TO vf-module (comprises generic-vnf, One2Many)
- TO volume-group (One2Many)
- - TO vnfc (One2Many, will delete target node)
+ - TO vnfc (One2Many)
- TO instance-group (Many2Many)
- TO entitlement (comprises generic-vnf, One2Many)
- TO license (comprises generic-vnf, One2Many)
- TO complex (Many2Many)
- TO ctag-pool (Many2Many)
+ - FROM line-of-business
+ - FROM platform
- FROM virtual-data-center
- FROM logical-link
- FROM allotted-resource
lag-link:
description: |
LAG links can connect lag-interfaces
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM lag-interface
- FROM logical-link
newvce:
description: |
This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO l-interface (comprises newvce, Many2Many)
required:
description: OBSOLETE - do not use
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.
pnf:
description: |
PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO p-interface (comprises pnf, Many2Many)
- TO lag-interface (comprises pnf, One2Many)
- TO complex (Many2One)
- TO instance-group (Many2Many)
- TO zone (Many2One)
+ - FROM esr-thirdparty-sdnc
- FROM generic-vnf
- FROM logical-link
- FROM service-instance
physical-link:
description: |
Collection of physical connections, typically between p-interfaces
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM p-interface
required:
service-provider-name:
type: string
description: Name of the service Provider on this link.
+ service-provider-bandwidth-up-value:
+ type: integer
+ format: int32
+ description: Upstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-up-units:
+ type: string
+ description: Units for the upstream BW value
+ service-provider-bandwidth-down-value:
+ type: integer
+ format: int32
+ description: Downstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-down-units:
+ type: string
+ description: Units for downstream BW value
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vig-server:
description: |
vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM ipsec-configuration (is composed of vig-server)
required:
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
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO vig-server (comprises ipsec-configuration, One2Many)
- FROM generic-vnf
route-table-reference:
description: |
Openstack route table reference.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network
required:
instance-group:
description: |
General mechanism for grouping instances
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO model (Many2Many)
- FROM l-interface
- FROM allotted-resource
- FROM generic-vnf
- FROM service-instance
+ - FROM vip-ipv4-address-list
+ - FROM vip-ipv6-address-list
required:
- instance-group-role
- model-invariant-id
zone:
description: |
A zone is a grouping of assets in a location homing to the same connections into the CBB
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO complex (Many2One)
- FROM cloud-region
type: array
items:
$ref: "#/definitions/vce"
- vpes:
- type: array
- items:
- $ref: "#/definitions/vpe"
vnfcs:
type: array
items:
cloud-infrastructure:
type: object
$ref: "#/definitions/cloud-infrastructure"
- license-management:
+ external-system:
type: object
- $ref: "#/definitions/license-management"
+ $ref: "#/definitions/external-system"
business:
type: object
$ref: "#/definitions/business"
type: string
key-value:
type: string
+ configurations:
+ description: |
+ Collection of configurations
+ properties:
+ configuration:
+ type: array
+ items:
+ $ref: "#/definitions/configuration"
+ configuration:
+ description: |
+ Port Mirror Configuration.
+ ###### Related Nodes
+ - TO logical-link (One2Many)
+ - TO metadatum (comprises configuration, One2Many)
+ - TO allotted-resource (One2One)
+ - FROM service-instance
+ - FROM generic-vnf
+ required:
+ - configuration-id
+ - configuration-type
+ - configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
+ properties:
+ management-option:
+ type: string
+ description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
+ configuration-id:
+ type: string
+ description: UUID assigned to configuration.
+ configuration-name:
+ type: string
+ description: Name of the configuration.
+ configuration-type:
+ type: string
+ description: port-mirroring-configuration.
+ configuration-sub-type:
+ type: string
+ description: vprobe, pprobe.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ orchestration-status:
+ type: string
+ description: Orchestration status of the configuration.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational.
+ configuration-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details from SDN-GC.
+ model-customization-id:
+ type: string
+ description: id of the configuration used to customize the resource
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ metadata:
+ type: object
+ $ref: "#/definitions/metadata"
notification-event:
properties:
cambria.partition:
type: string
multiplicityRule:
type: string
- isParent:
- type: boolean
- usesResource:
- type: boolean
- hasDelTarget:
- type: boolean
+ contains-other-v:
+ type: string
+ delete-other-v:
+ type: string
SVC-INFRA:
- type: boolean
- SVC-INFRA-REV:
- type: boolean
+ type: string
+ prevent-delete:
+ type: string
model-and-named-query-search:
description: |
ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
Code Review / aai / aai-common.git / blobdiff