description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id}/relationship-list/relationship:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAuthInfoItemsAuthInfoItemRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: auth-info-item-id
+ - name: esr-system-info-id
in: path
- description: Unique ID of auth-info-item.
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAuthInfoItemsAuthInfoItemRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: auth-info-item-id
+ - name: esr-system-info-id
in: path
- description: Unique ID of auth-info-item.
+ description: Unique ID of esr system info.
required: true
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id}:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
get:
tags:
- CloudInfrastructure
- summary: returns auth-info-item
- description: returns auth-info-item
- operationId: getCloudInfrastructureCloudRegionsCloudRegionAuthInfoItemsAuthInfoItem
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/auth-info-item"
+ $ref: "#/definitions/esr-system-info"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: auth-info-item-id
+ - name: esr-system-info-id
in: path
- description: Unique ID of auth-info-item.
+ description: Unique ID of esr system info.
required: true
type: string
- name: cloud-type
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- - name: username
+ - name: system-name
in: query
- description: user name of auth infomation to access VIM.
+ description: name of external system.
required: false
type: string
- - name: auth-url
+ - name: system-type
in: query
- description: authentication url of the cloud.
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
required: false
type: string
put:
tags:
- CloudInfrastructure
- summary: create or update an existing auth-info-item
- description: create or update an existing auth-info-item
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAuthInfoItemsAuthInfoItem
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: auth-info-item-id
+ - name: esr-system-info-id
in: path
- description: Unique ID of auth-info-item.
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
in: body
- description: auth-info-item object that needs to be created or updated
+ description: esr-system-info object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/auth-info-item"
+ $ref: "#/definitions/esr-system-info"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing auth-info-item
- description: delete an existing auth-info-item
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAuthInfoItemsAuthInfoItem
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: auth-info-item-id
+ - name: esr-system-info-id
in: path
- description: Unique ID of auth-info-item.
+ description: Unique ID of esr system info.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
get:
tags:
- CloudInfrastructure
- summary: returns auth-info-items
- description: returns auth-info-items
- operationId: getCloudInfrastructureCloudRegionsCloudRegionAuthInfoItems
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/auth-info-items"
+ $ref: "#/definitions/esr-system-info-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
$ref: "#/definitions/virtual-data-centers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-system-info"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: system-name
+ in: query
+ description: name of external system.
+ required: false
+ type: string
+ - name: system-type
+ in: query
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ required: false
+ type: string
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: esr-system-info object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-system-info"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-system-info-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ 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:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrEmsListEsrEmsRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ /external-system/esr-ems-list/esr-ems/{ems-id}:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-ems
+ description: returns esr-ems
+ operationId: getExternalSystemEsrEmsListEsrEms
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-ems"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-ems
+ description: create or update an existing esr-ems
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEms
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: esr-ems object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-ems"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-ems
+ description: delete an existing esr-ems
+ operationId: deleteExternalSystemEsrEmsListEsrEms
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /external-system/esr-ems-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-ems-list
+ description: returns esr-ems-list
+ operationId: getExternalSystemEsrEmsList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-ems-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-system-info"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: system-name
+ in: query
+ description: name of external system.
+ required: false
+ type: string
+ - name: system-type
+ in: query
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ required: false
+ type: string
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: esr-system-info object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-system-info"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-system-info-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-vnfm
+ description: returns esr-vnfm
+ operationId: getExternalSystemEsrVnfmListEsrVnfm
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-vnfm"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-vnfm
+ description: create or update an existing esr-vnfm
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfm
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: esr-vnfm object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-vnfm"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-vnfm
+ description: delete an existing esr-vnfm
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfm
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /external-system/esr-vnfm-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-vnfm-list
+ description: returns esr-vnfm-list
+ operationId: getExternalSystemEsrVnfmList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-vnfm-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-system-info"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: system-name
+ in: query
+ description: name of external system.
+ required: false
+ type: string
+ - name: system-type
+ in: query
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ required: false
+ type: string
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: esr-system-info object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-system-info"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-system-info-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ 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:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-thirdparty-sdnc
+ description: returns esr-thirdparty-sdnc
+ operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-thirdparty-sdnc
+ description: create or update an existing esr-thirdparty-sdnc
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: esr-thirdparty-sdnc object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-thirdparty-sdnc
+ description: delete an existing esr-thirdparty-sdnc
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /external-system/esr-thirdparty-sdnc-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-thirdparty-sdnc-list
+ description: returns esr-thirdparty-sdnc-list
+ operationId: getExternalSystemEsrThirdpartySdncList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-thirdparty-sdnc-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
/business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
put:
tags:
$ref: "#/definitions/customers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ /business/lines-of-business/line-of-business/{line-of-business-name}:
+ get:
+ tags:
+ - Business
+ summary: returns line-of-business
+ description: returns line-of-business
+ operationId: getBusinessLinesOfBusinessLineOfBusiness
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/line-of-business"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing line-of-business
+ description: create or update an existing line-of-business
+ operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: line-of-business object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/line-of-business"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing line-of-business
+ description: delete an existing line-of-business
+ operationId: deleteBusinessLinesOfBusinessLineOfBusiness
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/lines-of-business:
+ get:
+ tags:
+ - Business
+ summary: returns lines-of-business
+ description: returns lines-of-business
+ operationId: getBusinessLinesOfBusiness
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/lines-of-business"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ /business/owning-entities/owning-entity/{owning-entity-id}:
+ get:
+ tags:
+ - Business
+ summary: returns owning-entity
+ description: returns owning-entity
+ operationId: getBusinessOwningEntitiesOwningEntity
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/owning-entity"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing owning-entity
+ description: create or update an existing owning-entity
+ operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: owning-entity object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/owning-entity"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing owning-entity
+ description: delete an existing owning-entity
+ operationId: deleteBusinessOwningEntitiesOwningEntity
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/owning-entities:
+ get:
+ tags:
+ - Business
+ summary: returns owning-entities
+ description: returns owning-entities
+ operationId: getBusinessOwningEntities
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/owning-entities"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/platforms/platform/{platform-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ /business/platforms/platform/{platform-name}:
+ get:
+ tags:
+ - Business
+ summary: returns platform
+ description: returns platform
+ operationId: getBusinessPlatformsPlatform
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/platform"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing platform
+ description: create or update an existing platform
+ operationId: createOrUpdateBusinessPlatformsPlatform
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: platform object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/platform"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing platform
+ description: delete an existing platform
+ operationId: deleteBusinessPlatformsPlatform
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/platforms:
+ get:
+ tags:
+ - Business
+ summary: returns platforms
+ description: returns platforms
+ operationId: getBusinessPlatforms
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/platforms"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/projects/project/{project-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessProjectsProjectRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ /business/projects/project/{project-name}:
+ get:
+ tags:
+ - Business
+ summary: returns project
+ description: returns project
+ operationId: getBusinessProjectsProject
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/project"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing project
+ description: create or update an existing project
+ operationId: createOrUpdateBusinessProjectsProject
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: project object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/project"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing project
+ description: delete an existing project
+ operationId: deleteBusinessProjectsProject
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/projects:
+ get:
+ tags:
+ - Business
+ summary: returns projects
+ description: returns projects
+ operationId: getBusinessProjects
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/projects"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
put:
tags:
description: Unique ID of vnfc.
required: true
type: string
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
+ get:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: nfc-naming-code
+ in: query
+ description: Short code that is used in naming instances of the item being modeled
+ required: false
+ type: string
+ - name: nfc-function
+ in: query
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: prov status of this vnfc
+ required: false
+ type: string
+ - name: ipaddress-v4-oam-vip
+ in: query
+ description: Oam V4 vip address of this vnfc
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: group-notation
+ in: query
+ description: Group notation of VNFC
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: create or update an existing l3-interface-ipv4-address-list
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
+ get:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: nfc-naming-code
+ in: query
+ description: Short code that is used in naming instances of the item being modeled
+ required: false
+ type: string
+ - name: nfc-function
+ in: query
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: prov status of this vnfc
+ required: false
+ type: string
+ - name: ipaddress-v4-oam-vip
+ in: query
+ description: Oam V4 vip address of this vnfc
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: group-notation
+ in: query
+ description: Group notation of VNFC
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: create or update an existing l3-interface-ipv6-address-list
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
/network/vnfcs/vnfc/{vnfc-name}:
get:
tags:
$ref: "#/definitions/vnfcs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
+ get:
+ tags:
+ - Network
+ summary: returns host-route
+ description: returns host-route
+ operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/host-route"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: subnet-name
+ in: query
+ description: Name associated with the subnet.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing host-route
+ description: create or update an existing host-route
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: host-route object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/host-route"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing host-route
+ description: delete an existing host-route
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
+ get:
+ tags:
+ - Network
+ summary: returns host-routes
+ description: returns host-routes
+ operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/host-routes"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: subnet-name
+ in: query
+ description: Name associated with the subnet.
+ required: false
+ type: string
/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
put:
tags:
$ref: "#/definitions/zones"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVipIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVipIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /network/vip-ipv4-address-list/{vip-ipv4-address}:
+ get:
+ tags:
+ - Network
+ summary: returns vip-ipv4-address-list
+ description: returns vip-ipv4-address-list
+ operationId: getNetworkVipIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vip-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ 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 vip-ipv4-address-list
+ description: create or update an existing vip-ipv4-address-list
+ operationId: createOrUpdateNetworkVipIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: vip-ipv4-address-list object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/vip-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vip-ipv4-address-list
+ description: delete an existing vip-ipv4-address-list
+ operationId: deleteNetworkVipIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVipIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-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: deleteNetworkVipIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /network/vip-ipv6-address-list/{vip-ipv6-address}:
+ get:
+ tags:
+ - Network
+ summary: returns vip-ipv6-address-list
+ description: returns vip-ipv6-address-list
+ operationId: getNetworkVipIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vip-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ 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 vip-ipv6-address-list
+ description: create or update an existing vip-ipv6-address-list
+ operationId: createOrUpdateNetworkVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: vip-ipv6-address-list object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/vip-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vip-ipv6-address-list
+ description: delete an existing vip-ipv6-address-list
+ operationId: deleteNetworkVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
definitions:
search:
properties:
ctag-pool:
description: |
A collection of C tags (vlan tags) grouped for a specific purpose.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO availability-zone (Many2Many)
- FROM complex (is composed of ctag-pool)
complex:
description: |
Collection of physical locations that can house cloud-regions.
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO ctag-pool (comprises complex, Many2Many)
- TO l3-network (Many2Many)
volume-group:
description: |
Persistent block-level storage.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO complex (Many2Many)
- TO tenant (Many2Many)
volume:
description: |
Ephemeral Block storage volume.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM vserver (is composed of volume)
required:
l3-interface-ipv4-address-list:
description: |
IPv4 Address Range
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO instance-group (Many2Many)
- TO l3-network (Many2Many)
- TO subnet (Many2Many)
+ - TO vnfc (is composed of l3-interface-ipv4-address-list, Many2One)
- FROM l-interface (is composed of l3-interface-ipv4-address-list)
- FROM vlan (is composed of l3-interface-ipv4-address-list)
required:
l3-interface-ipv6-address-list:
description: |
IPv6 Address Range
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO instance-group (Many2Many)
- TO l3-network (Many2Many)
- TO subnet (Many2Many)
+ - TO vnfc (is composed of l3-interface-ipv6-address-list, Many2One)
- FROM l-interface (is composed of l3-interface-ipv6-address-list)
- FROM vlan (is composed of l3-interface-ipv6-address-list)
required:
vlan:
description: |
Definition of vlan
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO l3-interface-ipv4-address-list (comprises vlan, Many2Many)
- TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
sriov-vf:
description: |
SR-IOV Virtual Function (not to be confused with virtual network function)
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO sriov-pf (Many2One)
- FROM l-interface (is composed of sriov-vf)
l-interface:
description: |
Logical interfaces, e.g., a vnic.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO instance-group (Many2Many)
- TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
is-ip-unnumbered:
type: boolean
+ allowed-address-pairs:
+ type: string
+ description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
vlans:
type: array
items:
vserver:
description: |
Virtual Servers, aka virtual machine or VM.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO flavor (Many2One)
- TO image (Many2One)
tenant:
description: |
Openstack tenant
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO l3-network (Many2Many)
- TO service-subscription (Many2Many)
- TO vserver (comprises tenant, One2Many)
- - FROM auth-info-item
- FROM cloud-region (is composed of tenant)
- FROM group-assignment
- FROM volume-group
flavor:
description: |
Openstack flavor.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- FROM cloud-region (is composed of flavor)
- FROM vserver
group-assignment:
description: |
Openstack group-assignment used to store exclusivity groups (EG).
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO tenant (Many2Many)
- TO pserver (One2Many)
snapshot:
description: |
Openstack snapshot
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM cloud-region (is composed of snapshot)
- FROM vserver
metadatum:
description: |
Key/value pairs
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM image (is composed of metadatum)
- FROM model-ver (is composed of metadatum)
metadata:
description: |
Collection of metadatum (key/value pairs)
- ###### Default Delete Scope
- THIS_NODE_ONLY
properties:
metadatum:
type: array
image:
description: |
Openstack image.
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO metadatum (comprises image, Many2Many)
- FROM cloud-region (is composed of image)
dvs-switch:
description: |
Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO availability-zone (Many2Many)
- FROM cloud-region (is composed of dvs-switch)
oam-network:
description: |
OAM network, to be deprecated shortly. Do not use for new purposes.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- TO complex (Many2Many)
- TO service-capability (Many2Many)
availability-zone:
description: |
Availability zone, a collection of compute hosts/pservers
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- TO complex (Many2Many)
- TO service-capability (Many2Many)
type: array
items:
$ref: "#/definitions/availability-zone"
- auth-info-item:
+ esr-system-info:
description: |
- Persistent auth info.
+ Persist common address information of external systems.
###### Related Nodes
- - TO tenant (One2One)
- - FROM cloud-region (is composed of auth-info-item)
+ - FROM esr-ems (is composed of esr-system-info)
+ - FROM esr-vnfm (is composed of esr-system-info)
+ - FROM esr-thirdparty-sdnc (is composed of esr-system-info)
+ - FROM cloud-region (is composed of esr-system-info)
required:
- - auth-info-item-id
- - cloud-domain
- - username
+ - esr-system-info-id
+ - user-name
- password
- - auth-url
- - ssl-cacert
- - ssl-insecure
+ - system-type
properties:
- auth-info-item-id:
+ esr-system-info-id:
type: string
- description: Unique ID of auth-info-item.
- cloud-domain:
+ description: Unique ID of esr system info.
+ system-name:
type: string
- description: domain info for authentication.
- username:
+ description: name of external system.
+ type:
type: string
- description: user name of auth infomation to access VIM.
+ description: type of external systems.
+ vendor:
+ type: string
+ description: vendor of external systems.
+ version:
+ type: string
+ description: version of external systems.
+ service-url:
+ type: string
+ description: url used to access external systems.
+ user-name:
+ type: string
+ description: username used to access external systems.
password:
type: string
- description: password of auth infomation to access VIM.
- auth-url:
+ description: password used to access external systems.
+ system-type:
+ type: string
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ protocol:
type: string
- description: authentication url of the cloud.
+ description: protocol of third party SDNC, for example netconf/snmp.
ssl-cacert:
type: string
description: ca file content if enabled ssl on auth-url.
ssl-insecure:
type: boolean
description: Whether to verify VIM's certificate.
+ ip-address:
+ type: string
+ description: service IP of ftp server.
+ port:
+ type: string
+ description: service port of ftp server.
+ cloud-domain:
+ type: string
+ description: domain info for authentication.
+ default-tenant:
+ type: string
+ description: default tenant of VIM.
+ passive:
+ type: boolean
+ description: ftp passive mode or not.
+ remote-path:
+ type: string
+ description: resource or performance data file path.
+ system-status:
+ type: string
+ description: the status of external system.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- auth-info-items:
+ esr-system-info-list:
description: |
- Collection of persistent auth information to access to VIM.
+ Collection of persistent block-level external system auth info.
properties:
- auth-info-item:
+ esr-system-info:
type: array
items:
- $ref: "#/definitions/auth-info-item"
+ $ref: "#/definitions/esr-system-info"
cloud-region:
description: |
cloud-region designates an installation of a cloud cluster or region or instantiation.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
+ - TO esr-system-info (comprises cloud-region, One2Many)
- TO complex (Many2One)
- TO l3-network (Many2Many)
- TO tenant (comprises cloud-region, One2Many)
- - TO auth-info-item (comprises cloud-region, One2Many)
- TO image (comprises cloud-region, One2Many)
- TO flavor (comprises cloud-region, One2Many)
- TO availability-zone (comprises cloud-region, One2Many)
description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
sriov-automation:
type: boolean
+ cloud-extra-info:
+ type: string
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- auth-info-items:
+ esr-system-info-list:
type: array
items:
- $ref: "#/definitions/auth-info-item"
+ $ref: "#/definitions/esr-system-info"
cloud-regions:
properties:
cloud-region:
network-profile:
description: |
Network profile populated by SDN-GP for SNMP
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM generic-vnf
required:
sriov-pf:
description: |
SR-IOV Physical Function
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM p-interface (is composed of sriov-pf)
- FROM sriov-vf
p-interface:
description: |
Physical interface (e.g., nic)
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO l-interface (comprises p-interface, Many2Many)
- TO physical-link (Many2Many)
prov-status:
type: string
description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
lag-interface:
description: |
Link aggregate interface
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO logical-link (Many2Many)
- TO lag-link (Many2Many)
pserver:
description: |
Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO complex (Many2One)
- TO cloud-region (Many2One)
virtual-data-center:
description: |
Virtual organization of cloud infrastructure elements in a data center context
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO generic-vnf (Many2Many)
- TO logical-link (Many2Many)
type: array
items:
$ref: "#/definitions/virtual-data-center"
+ esr-ems:
+ description: |
+ Persist EMS address information used by EMS driver.
+ ###### Related Nodes
+ - TO esr-system-info (comprises esr-ems, One2Many)
+ required:
+ - ems-id
+ properties:
+ ems-id:
+ type: string
+ description: Unique ID of EMS.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ esr-ems-list:
+ properties:
+ esr-ems:
+ type: array
+ items:
+ $ref: "#/definitions/esr-ems"
+ esr-vnfm:
+ description: |
+ Persist VNFM address information used by VF-C.
+ ###### Related Nodes
+ - TO esr-system-info (comprises esr-vnfm, One2One)
+ required:
+ - vnfm-id
+ properties:
+ vnfm-id:
+ type: string
+ description: Unique ID of VNFM.
+ vim-id:
+ type: string
+ description: indecate the VIM to deploy VNF.
+ certificate-url:
+ type: string
+ description: certificate url of VNFM.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ esr-vnfm-list:
+ properties:
+ esr-vnfm:
+ type: array
+ items:
+ $ref: "#/definitions/esr-vnfm"
+ esr-thirdparty-sdnc:
+ description: |
+ Persist SDNC address information used by ONAP SDNC.
+ ###### Related Nodes
+ - TO esr-system-info (comprises esr-thirdparty-sdnc, One2One)
+ - TO pnf (One2Many)
+ required:
+ - thirdparty-sdnc-id
+ properties:
+ thirdparty-sdnc-id:
+ type: string
+ description: Unique ID of SDNC.
+ location:
+ type: string
+ description: used for DC type to indicate the location of SDNC, such as Core or Edge.
+ product-name:
+ type: string
+ description: password used to access SDNC server.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ esr-thirdparty-sdnc-list:
+ properties:
+ esr-thirdparty-sdnc:
+ type: array
+ items:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ external-system:
+ description: |
+ Namespace for external system.
+ properties:
+ esr-ems-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-ems"
+ esr-vnfm-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-vnfm"
+ esr-thirdparty-sdnc-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
connector:
description: |
Collection of resource instances used to connect a variety of disparate inventory widgets
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO virtual-data-center (Many2Many)
- TO metadatum (comprises connector, Many2Many)
tunnel-xconnect:
description: |
Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM allotted-resource (is composed of tunnel-xconnect)
required:
allotted-resource:
description: |
Represents a slice or partial piece of a resource that gets separately allotted
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO generic-vnf (Many2Many)
- TO l3-network (Many2Many)
service-instance:
description: |
Instance of a service
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO zone (Many2One)
- TO cvlan-tag (Many2Many)
- TO allotted-resource (Many2Many)
- FROM generic-vnf
- FROM l3-network
+ - FROM owning-entity
+ - FROM project
- FROM service-subscription (is composed of service-instance)
- FROM vce
- FROM service-instance
service-subscription:
description: |
Object that group service instances.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO service-instance (comprises service-subscription, Many2Many)
- FROM customer (is composed of service-subscription)
customer:
description: |
customer identifiers to provide linkage back to BSS information.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO service-subscription (comprises customer, Many2Many)
required:
type: array
items:
$ref: "#/definitions/customer"
+ line-of-business:
+ description: |
+ describes a line-of-business
+ ###### Related Nodes
+ - TO generic-vnf (Many2Many)
+ required:
+ - line-of-business-name
+ properties:
+ line-of-business-name:
+ type: string
+ description: Name of the line-of-business (product)
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ lines-of-business:
+ description: |
+ Collection of lines-of-business
+ properties:
+ line-of-business:
+ type: array
+ items:
+ $ref: "#/definitions/line-of-business"
+ owning-entity:
+ description: |
+ describes an owning-entity
+ ###### Related Nodes
+ - TO service-instance (One2Many)
+ required:
+ - owning-entity-id
+ - owning-entity-name
+ properties:
+ owning-entity-id:
+ type: string
+ description: UUID of an owning entity
+ owning-entity-name:
+ type: string
+ description: Owning entity name
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ owning-entities:
+ description: |
+ Collection of owning-entities
+ properties:
+ owning-entity:
+ type: array
+ items:
+ $ref: "#/definitions/owning-entity"
+ platform:
+ description: |
+ describes a platform
+ ###### Related Nodes
+ - TO generic-vnf (Many2Many)
+ required:
+ - platform-name
+ properties:
+ platform-name:
+ type: string
+ description: Name of the platform
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ platforms:
+ description: |
+ Collection of platforms
+ properties:
+ platform:
+ type: array
+ items:
+ $ref: "#/definitions/platform"
+ project:
+ description: |
+ describes the project
+ ###### Related Nodes
+ - TO service-instance (One2Many)
+ required:
+ - project-name
+ properties:
+ project-name:
+ type: string
+ description: Name of the project deploying a service
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ projects:
+ description: |
+ Collection of projects
+ properties:
+ project:
+ type: array
+ items:
+ $ref: "#/definitions/project"
business:
description: |
Namespace for business related constructs
type: array
items:
$ref: "#/definitions/customer"
+ lines-of-business:
+ type: array
+ items:
+ $ref: "#/definitions/line-of-business"
+ owning-entities:
+ type: array
+ items:
+ $ref: "#/definitions/owning-entity"
+ platforms:
+ type: array
+ items:
+ $ref: "#/definitions/platform"
+ projects:
+ type: array
+ items:
+ $ref: "#/definitions/project"
vnf-image:
description: |
Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- FROM generic-vnf
required:
service:
description: |
Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
required:
- service-id
- service-description
service-capability:
description: |
Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- FROM availability-zone
- FROM oam-network
element-choice-set:
description: |
This is how we would capture constraints defining allowed sets of elements.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO model-element (comprises element-choice-set, One2Many)
- FROM constrained-element-set (is composed of element-choice-set)
constrained-element-set:
description: |
This is how we would capture constraints defining allowed sets of elements.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO element-choice-set (comprises constrained-element-set, One2Many)
- FROM model-element (is composed of constrained-element-set)
model-constraint:
description: |
This is how we would capture constraints defining allowed sets of elements.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO constrained-element-set (comprises model-constraint, One2Many)
- FROM model-element (is composed of model-constraint)
model-element:
description: |
Defines how other models combine to make up a higher-level model.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO model-ver (Many2One)
- TO model-element (comprises model-element, One2Many)
model-ver:
description: |
Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO model-element (comprises model-ver, One2Many)
- TO metadatum (comprises model-ver, One2Many)
model:
description: |
Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO model-ver (comprises model, One2Many)
- FROM named-query
related-lookup:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- FROM named-query-element (is composed of related-lookup)
required:
property-constraint:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- FROM named-query-element (is composed of property-constraint)
required:
named-query-element:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO named-query-element (comprises named-query-element, Many2Many)
- TO model (Many2One)
named-query:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO model (One2Many)
- TO named-query-element (comprises named-query, One2One)
logical-link:
description: |
Logical links generally connect l-interfaces but are used to express logical connectivity between two points
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO lag-link (Many2Many)
- TO pnf (Many2Many)
$ref: "#/definitions/logical-link"
class-of-service:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM site-pair (is composed of class-of-service)
required:
$ref: "#/definitions/class-of-service"
site-pair:
description: |
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO class-of-service (comprises site-pair, Many2Many)
- FROM routing-instance (is composed of site-pair)
$ref: "#/definitions/site-pair"
routing-instance:
description: |
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO site-pair (comprises routing-instance, Many2Many)
- FROM site-pair-set (is composed of routing-instance)
site-pair-set:
description: |
Set of instances for probes used to measure service level agreements
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO routing-instance (comprises site-pair-set, Many2Many)
- FROM generic-vnf
route-target:
description: |
Route target information
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- FROM vpn-binding (is composed of route-target)
required:
vpn-binding:
description: |
VPN binding
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO route-target (comprises vpn-binding, One2Many)
- FROM l3-network
vpls-pe:
description: |
VPLS Provider Edge routers.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO complex (Many2Many)
- TO ctag-pool (Many2Many)
$ref: "#/definitions/vpls-pe"
multicast-configuration:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM vlan
required:
port-group:
description: |
Used to capture the network interfaces of this VCE
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO cvlan-tag (comprises port-group, Many2Many)
- FROM vce (is composed of port-group)
license:
description: |
Metadata for license group.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM generic-vnf (is composed of license)
- FROM vce (is composed of license)
entitlement:
description: |
Metadata for entitlement group.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM generic-vnf (is composed of entitlement)
- FROM vce (is composed of entitlement)
vce:
description: |
Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO availability-zone (Many2Many)
- TO complex (Many2Many)
$ref: "#/definitions/vce"
vnfc:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO instance-group (Many2Many)
+ - TO vip-ipv4-address-list (Many2Many)
+ - TO vip-ipv6-address-list (Many2Many)
- FROM vserver
- FROM vf-module
- FROM generic-vnf
+ - FROM l3-interface-ipv4-address-list (comprises vnfc)
+ - FROM l3-interface-ipv6-address-list (comprises vnfc)
required:
- vnfc-name
- nfc-naming-code
type: array
items:
$ref: "#/definitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
vnfcs:
description: |
virtual network components associated with a vserver from application controller.
type: array
items:
$ref: "#/definitions/vnfc"
+ host-route:
+ description: |
+ ###### Related Nodes
+ - FROM subnet (is composed of host-route)
+ required:
+ - host-route-id
+ - route-prefix
+ - next-hop
+ properties:
+ host-route-id:
+ type: string
+ description: host-route id
+ route-prefix:
+ type: string
+ description: subnet prefix
+ next-hop:
+ type: string
+ description: Could be ip-address, hostname, or service-instance
+ next-hop-type:
+ type: string
+ description: Should be ip-address, hostname, or service-instance to match next-hop
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ host-routes:
+ properties:
+ host-route:
+ type: array
+ items:
+ $ref: "#/definitions/host-route"
subnet:
description: |
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
+ - TO host-route (comprises subnet, One2Many)
- FROM l3-interface-ipv4-address-list
- FROM l3-interface-ipv6-address-list
- FROM l3-network (is composed of subnet)
subnet-role:
type: string
description: role of the subnet, referenced when assigning IPs
+ ip-assignment-direction:
+ type: string
+ description: ip address assignment direction of the subnet
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ subnet-sequence:
+ type: integer
+ format: int32
+ description: sequence of the subnet
+ host-routes:
+ type: array
+ items:
+ $ref: "#/definitions/host-route"
relationship-list:
type: array
items:
$ref: "#/definitions/subnet"
ctag-assignment:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network (is composed of ctag-assignment)
- FROM service-instance
segmentation-assignment:
description: |
Openstack segmentation assignment.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network (is composed of segmentation-assignment)
required:
l3-network:
description: |
Generic network definition
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO vpn-binding (Many2Many)
- TO instance-group (Many2Many)
$ref: "#/definitions/l3-network"
network-policy:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network
- FROM allotted-resource
vf-module:
description: |
a deployment unit of VNFCs
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO volume-group (One2One)
- TO l3-network (Many2Many)
generic-vnf:
description: |
General purpose VNF
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO license-key-resource (Many2Many)
- TO l-interface (comprises generic-vnf, Many2Many)
- TO license (comprises generic-vnf, One2Many)
- TO complex (Many2Many)
- TO ctag-pool (Many2Many)
+ - FROM line-of-business
+ - FROM platform
- FROM virtual-data-center
- FROM logical-link
- FROM allotted-resource
lag-link:
description: |
LAG links can connect lag-interfaces
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM lag-interface
- FROM logical-link
newvce:
description: |
This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO l-interface (comprises newvce, Many2Many)
required:
pnf:
description: |
PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO p-interface (comprises pnf, Many2Many)
- TO lag-interface (comprises pnf, One2Many)
- TO complex (Many2One)
- TO instance-group (Many2Many)
- TO zone (Many2One)
+ - FROM esr-thirdparty-sdnc
- FROM generic-vnf
- FROM logical-link
- FROM service-instance
physical-link:
description: |
Collection of physical connections, typically between p-interfaces
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM p-interface
required:
vig-server:
description: |
vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM ipsec-configuration (is composed of vig-server)
required:
ipsec-configuration:
description: |
IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO vig-server (comprises ipsec-configuration, One2Many)
- FROM generic-vnf
route-table-reference:
description: |
Openstack route table reference.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network
required:
instance-group:
description: |
General mechanism for grouping instances
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO model (Many2Many)
- FROM l-interface
zone:
description: |
A zone is a grouping of assets in a location homing to the same connections into the CBB
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO complex (Many2One)
- FROM cloud-region
type: array
items:
$ref: "#/definitions/zone"
+ vip-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - FROM vnfc
+ required:
+ - vip-ipv4-address
+ properties:
+ vip-ipv4-address:
+ type: string
+ description: IP address
+ vip-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vip-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - FROM vnfc
+ required:
+ - vip-ipv6-address
+ properties:
+ vip-ipv6-address:
+ type: string
+ description: IP address
+ vip-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
network:
description: |
Namespace for network inventory resources.
type: array
items:
$ref: "#/definitions/zone"
+ vip-ipv4-address-list:
+ type: object
+ $ref: "#/definitions/vip-ipv4-address-list"
+ vip-ipv6-address-list:
+ type: object
+ $ref: "#/definitions/vip-ipv6-address-list"
inventory:
properties:
search:
cloud-infrastructure:
type: object
$ref: "#/definitions/cloud-infrastructure"
+ external-system:
+ type: object
+ $ref: "#/definitions/external-system"
business:
type: object
$ref: "#/definitions/business"
Code Review / aai / aai-common.git / blobdiff