X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_yaml%2Faai_swagger_v11.yaml;fp=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_yaml%2Faai_swagger_v11.yaml;h=fc6fe19a7caf00775aa0e384930dbeb173509e43;hb=3aceb7c3254d2568e9aaf358af0143830b5c7916;hp=1e2e70f70ec4e2dd657174b13ce61bfd6a0719b8;hpb=bb87ed1b5fcfb5393f2ab240fc429d497d6ffb6a;p=aai%2Faai-common.git diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml index 1e2e70f7..fc6fe19a 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml @@ -794,6 +794,11 @@ paths: 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 @@ -963,6 +968,11 @@ paths: 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 @@ -1338,6 +1348,11 @@ paths: 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 @@ -1692,6 +1707,11 @@ paths: 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 @@ -1933,6 +1953,11 @@ paths: 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 @@ -2143,6 +2168,11 @@ paths: 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 @@ -2342,6 +2372,11 @@ paths: 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 @@ -2561,291 +2596,9 @@ paths: 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 + - name: tenant-context 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 - /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 @@ -2886,28 +2639,12 @@ paths: 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 @@ -2943,23 +2680,18 @@ paths: 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 @@ -2995,22 +2727,12 @@ paths: 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 @@ -3046,7 +2768,7 @@ paths: 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 @@ -3062,7 +2784,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -3098,18 +2820,18 @@ paths: 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 @@ -3117,7 +2839,7 @@ paths: "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: @@ -3146,7 +2868,7 @@ paths: 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 @@ -3166,6 +2888,11 @@ paths: 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 @@ -3223,9 +2950,9 @@ paths: 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 @@ -3261,23 +2988,23 @@ paths: 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 @@ -3313,7 +3040,7 @@ paths: 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 @@ -3323,13 +3050,111 @@ paths: 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, 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-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, 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-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 @@ -3337,7 +3162,7 @@ paths: "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: @@ -3366,6 +3191,11 @@ paths: 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) @@ -3381,6 +3211,11 @@ paths: 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 @@ -3419,12 +3254,28 @@ paths: 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 @@ -3460,18 +3311,23 @@ paths: 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 @@ -3507,18 +3363,23 @@ paths: 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 @@ -3526,7 +3387,201 @@ paths: "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 + 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, 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: 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, 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: 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: @@ -3565,6 +3620,11 @@ paths: 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 @@ -3641,6 +3701,11 @@ paths: 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 @@ -3795,6 +3860,11 @@ paths: 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: @@ -3911,6 +3981,11 @@ paths: 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 @@ -11805,6 +11880,16 @@ paths: 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. @@ -11964,6 +12049,16 @@ paths: 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. @@ -12140,6 +12235,16 @@ paths: 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. @@ -12336,6 +12441,16 @@ paths: 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. @@ -12517,6 +12632,16 @@ paths: 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. @@ -12698,82 +12823,102 @@ paths: 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 - 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 service-instance - description: returns service-instance - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/service-instance" - "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: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type + - name: environment-context in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. + description: This field will store the environment context assigned to the service-instance. required: false type: string - - name: service-instance-name + - name: workload-context in: query - description: This field will store a name assigned to the service-instance. + 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 service-instance + description: returns service-instance + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/definitions/service-instance" + "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: 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: 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 @@ -13260,7 +13405,7 @@ paths: $ref: "#/definitions/customers" "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: + /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: put: tags: - ServiceDesignAndCreation @@ -13276,7 +13421,7 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: att-uuid + - name: vnf-image-uuid in: path description: Unique ID of this asset required: true @@ -13303,12 +13448,12 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: att-uuid + - name: vnf-image-uuid in: path description: Unique ID of this asset required: true type: string - /service-design-and-creation/vnf-images/vnf-image/{att-uuid}: + /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}: get: tags: - ServiceDesignAndCreation @@ -13326,7 +13471,7 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: att-uuid + - name: vnf-image-uuid in: path description: Unique ID of this asset required: true @@ -13362,7 +13507,7 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: att-uuid + - name: vnf-image-uuid in: path description: Unique ID of this asset required: true @@ -13389,7 +13534,7 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: att-uuid + - name: vnf-image-uuid in: path description: Unique ID of this asset required: true @@ -22771,5035 +22916,18 @@ paths: description: Unique ID of an entitlement resource. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vces/vce/{vnf-id}/entitlements: - get: - tags: - - Network - summary: returns entitlements - description: returns entitlements - operationId: getNetworkVcesVceEntitlements - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/entitlements" - "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}/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 vce - description: returns vce - operationId: getNetworkVcesVce - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vce" - "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 - put: - tags: - - Network - summary: create or update an existing vce - description: create or update an existing vce - operationId: createOrUpdateNetworkVcesVce - 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: vce object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/vce" - delete: - tags: - - Network - summary: delete an existing vce - description: delete an existing vce - operationId: deleteNetworkVcesVce - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vces: - get: - tags: - - Network - summary: returns vces - description: returns vces - operationId: getNetworkVces - produces: - - application/json - - application/xml - responses: - "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: - "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: 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 - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: body - in: body - description: 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: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - /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: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-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: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - 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}: - get: - tags: - - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: 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 - 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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-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: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: 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: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - /network/vpes/vpe/{vnf-id}/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: getNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: 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 - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-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: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: - tags: - - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: - get: - tags: - - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkVpesVpeLInterfacesLInterfaceVlansVlan - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vlan" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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: 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 - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: body - in: body - description: vlan object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/vlan" - delete: - tags: - - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkVpesVpeLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans: - get: - tags: - - Network - summary: returns vlans - description: returns vlans - operationId: getNetworkVpesVpeLInterfacesLInterfaceVlans - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vlans" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: - get: - tags: - - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVf - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/sriov-vf" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - required: false - type: string - put: - tags: - - Network - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVf - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - - name: body - in: body - description: sriov-vf object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/sriov-vf" - delete: - tags: - - Network - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteNetworkVpesVpeLInterfacesLInterfaceSriovVfsSriovVf - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs: - get: - tags: - - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkVpesVpeLInterfacesLInterfaceSriovVfs - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/sriov-vfs" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLInterfacesLInterfaceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: - tags: - - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: - tags: - - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: - tags: - - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: - tags: - - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVpesVpeLInterfacesLInterfaceL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}: - get: - tags: - - Network - summary: returns l-interface - description: returns l-interface - operationId: getNetworkVpesVpeLInterfacesLInterface - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l-interface" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - put: - tags: - - Network - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateNetworkVpesVpeLInterfacesLInterface - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: body - in: body - description: l-interface object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l-interface" - delete: - tags: - - Network - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteNetworkVpesVpeLInterfacesLInterface - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/l-interfaces: - get: - tags: - - Network - summary: returns l-interfaces - description: returns l-interfaces - operationId: getNetworkVpesVpeLInterfaces - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l-interfaces" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: - tags: - - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: - tags: - - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: - tags: - - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: - tags: - - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: - get: - tags: - - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vlan" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - put: - tags: - - Network - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: body - in: body - description: vlan object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/vlan" - delete: - tags: - - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: - get: - tags: - - Network - summary: returns vlans - description: returns vlans - operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vlans" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: - get: - tags: - - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/sriov-vf" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string - put: - tags: - - Network - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - - name: body - in: body - description: sriov-vf object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/sriov-vf" - delete: - tags: - - Network - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: - get: - tags: - - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/sriov-vfs" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: - tags: - - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: - tags: - - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: - tags: - - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: - tags: - - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: - get: - tags: - - Network - summary: returns l-interface - description: returns l-interface - operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l-interface" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - put: - tags: - - Network - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: body - in: body - description: l-interface object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l-interface" - delete: - tags: - - Network - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteNetworkVpesVpeLagInterfacesLagInterfaceLInterfacesLInterface - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: - get: - tags: - - Network - summary: returns l-interfaces - description: returns l-interfaces - operationId: getNetworkVpesVpeLagInterfacesLagInterfaceLInterfaces - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l-interfaces" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - /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 - 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 - put: - tags: - - Network - summary: create or update an existing lag-interface - description: create or update an existing lag-interface - operationId: createOrUpdateNetworkVpesVpeLagInterfacesLagInterface - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: body - in: body - description: lag-interface object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/lag-interface" - delete: - tags: - - Network - summary: delete an existing lag-interface - description: delete an existing lag-interface - operationId: deleteNetworkVpesVpeLagInterfacesLagInterface - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/lag-interfaces: - get: - tags: - - Network - summary: returns lag-interfaces - description: returns lag-interfaces - operationId: getNetworkVpesVpeLagInterfaces - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/lag-interfaces" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 - /network/vpes/vpe/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeLicensesLicenseRelationshipListRelationship - 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: deleteNetworkVpesVpeLicensesLicenseRelationshipListRelationship - 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/vpes/vpe/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: - get: - tags: - - Network - summary: returns license - description: returns license - operationId: getNetworkVpesVpeLicensesLicense - 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 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 - put: - tags: - - Network - summary: create or update an existing license - description: create or update an existing license - operationId: createOrUpdateNetworkVpesVpeLicensesLicense - 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: deleteNetworkVpesVpeLicensesLicense - 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/vpes/vpe/{vnf-id}/licenses: - get: - tags: - - Network - summary: returns licenses - description: returns licenses - operationId: getNetworkVpesVpeLicenses - 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 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 - /network/vpes/vpe/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpesVpeEntitlementsEntitlementRelationshipListRelationship - 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 entitlement group the resource comes from, should be uuid. - required: true - type: string - - name: resource-uuid - in: path - description: Unique ID of an entitlement 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: deleteNetworkVpesVpeEntitlementsEntitlementRelationshipListRelationship - 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 entitlement group the resource comes from, should be uuid. - required: true - type: string - - name: resource-uuid - in: path - description: Unique ID of an entitlement resource. - required: true - type: string - /network/vpes/vpe/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces/vce/{vnf-id}/entitlements: get: tags: - Network - summary: returns entitlement - description: returns entitlement - operationId: getNetworkVpesVpeEntitlementsEntitlement + summary: returns entitlements + description: returns entitlements + operationId: getNetworkVcesVceEntitlements produces: - application/json - application/xml @@ -27807,7 +22935,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/entitlement" + $ref: "#/definitions/entitlements" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -27816,16 +22944,6 @@ paths: 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 entitlement group the resource comes from, should be uuid. - required: true - type: string - - name: resource-uuid - in: path - description: Unique ID of an entitlement resource. - required: true - type: string - name: vnf-name in: query description: Name of VNF. @@ -27843,7 +22961,7 @@ paths: 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 @@ -27861,12 +22979,17 @@ paths: 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}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing entitlement - description: create or update an existing entitlement - operationId: createOrUpdateNetworkVpesVpeEntitlementsEntitlement + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship consumes: - application/json - application/xml @@ -27882,28 +23005,18 @@ paths: 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 entitlement group the resource comes from, should be uuid. - required: true - type: string - - name: resource-uuid - in: path - description: Unique ID of an entitlement resource. - required: true - type: string - name: body in: body - description: entitlement object that needs to be created or updated + description: relationship object that needs to be created or updated required: true schema: - $ref: "#/definitions/entitlement" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing entitlement - description: delete an existing entitlement - operationId: deleteNetworkVpesVpeEntitlementsEntitlement + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVceRelationshipListRelationship consumes: - application/json - application/xml @@ -27919,28 +23032,13 @@ paths: 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 entitlement group the resource comes from, should be uuid. - required: true - type: string - - name: resource-uuid - in: path - description: Unique ID of an entitlement resource. - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/vpes/vpe/{vnf-id}/entitlements: + /network/vces/vce/{vnf-id}: get: tags: - Network - summary: returns entitlements - description: returns entitlements - operationId: getNetworkVpesVpeEntitlements + summary: returns vce + description: returns vce + operationId: getNetworkVcesVce produces: - application/json - application/xml @@ -27948,7 +23046,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/entitlements" + $ref: "#/definitions/vce" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -27974,7 +23072,7 @@ paths: 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 @@ -27992,70 +23090,17 @@ paths: description: Heat stack id corresponding to this instance, managed by MSO required: false type: string - /network/vpes/vpe/{vnf-id}: - get: - tags: - - Network - summary: returns vpe - description: returns vpe - operationId: getNetworkVpesVpe - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vpe" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded 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 + - name: vpe-id in: query - description: Heat stack id corresponding to this instance, managed by MSO + 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 @@ -28073,16 +23118,16 @@ paths: 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 @@ -28103,13 +23148,13 @@ paths: 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 @@ -28117,7 +23162,7 @@ paths: "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: @@ -43843,7 +38888,6 @@ definitions: ###### Related Nodes - TO availability-zone (Many2Many) - FROM complex (is composed of ctag-pool) - - FROM vpe - FROM vpls-pe - FROM generic-vnf required: @@ -43890,7 +38934,6 @@ definitions: - FROM pserver - FROM pnf - FROM vce - - FROM vpe - FROM vpls-pe - FROM volume-group - FROM zone @@ -44143,13 +39186,14 @@ definitions: - 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 @@ -44188,6 +39232,8 @@ definitions: 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: @@ -44281,14 +39327,13 @@ definitions: - 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) @@ -44296,6 +39341,7 @@ definitions: - interface-name - is-port-mirrored - in-maint + - is-ip-unnumbered properties: interface-name: type: string @@ -44334,6 +39380,8 @@ definitions: prov-status: type: string description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean vlans: type: array items: @@ -44374,7 +39422,6 @@ definitions: ###### 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) @@ -44384,7 +39431,6 @@ definitions: - FROM generic-vnf - FROM tenant (is composed of vserver) - FROM vce - - FROM vpe required: - vserver-id - vserver-name @@ -44456,6 +39502,9 @@ definitions: 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. @@ -44660,8 +39709,6 @@ definitions: Collection of metadatum (key/value pairs) ###### Default Delete Scope THIS_NODE_ONLY - ###### Related Nodes - - FROM image (is composed of metadata) properties: metadatum: type: array @@ -44673,7 +39720,6 @@ definitions: ###### 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 @@ -44757,7 +39803,7 @@ definitions: $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 @@ -45018,7 +40064,7 @@ definitions: 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 @@ -45087,14 +40133,13 @@ definitions: ###### 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 @@ -45480,8 +40525,10 @@ definitions: - TO l-interface (One2Many) - TO tunnel-xconnect (comprises allotted-resource, One2One) - TO vpn-binding (Many2Many) + - TO allotted-resource (One2One) - FROM service-instance (is composed of allotted-resource) - FROM service-instance + - FROM allotted-resource required: - id properties: @@ -45545,7 +40592,7 @@ definitions: - 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) @@ -45559,6 +40606,8 @@ definitions: - FROM service-instance required: - service-instance-id + - service-type + - service-role properties: service-instance-id: type: string @@ -45566,6 +40615,18 @@ definitions: 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. @@ -45728,11 +40789,11 @@ definitions: ###### 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: @@ -46267,11 +41328,14 @@ definitions: - 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 @@ -46591,7 +41655,7 @@ definitions: 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. @@ -46745,7 +41809,6 @@ definitions: ###### 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 @@ -46779,7 +41842,6 @@ definitions: ###### 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 @@ -46904,120 +41966,6 @@ definitions: 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 @@ -47363,7 +42311,7 @@ definitions: ###### 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: @@ -47448,7 +42396,7 @@ definitions: - TO ipsec-configuration (Many2One) - TO vf-module (comprises generic-vnf, One2Many) - TO volume-group (One2Many) - - TO vnfc (One2Many, will delete target node) + - TO vnfc (One2Many) - TO instance-group (Many2Many) - TO entitlement (comprises generic-vnf, One2Many) - TO license (comprises generic-vnf, One2Many) @@ -47713,10 +42661,10 @@ definitions: 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. @@ -48187,10 +43135,6 @@ definitions: type: array items: $ref: "#/definitions/vce" - vpes: - type: array - items: - $ref: "#/definitions/vpe" vnfcs: type: array items: @@ -48495,16 +43439,14 @@ definitions: 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