GENERIC-RESOURCE-API(2017-08-24)

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)configuration-operation-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
**(config)request-information body
**(config)sdnc-request-header body
**(config)configuration-information body
**(config)gc-request-input body
**(config)service-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
(config)vm-names body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
**(config)vnfc-names body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/service-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)service-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/service-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
**(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/service-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/service-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
(config)vnic-sub-interfaces body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
**(config)sub-interface-network-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/dest-vnfc-instance-group-id

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)dest-vnfc-instance-group-id body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/dest-vnfc-instance-group-id

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/dest-vnfc-instance-group-id

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
(config)sdnc-request-header body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments/source-network

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)source-network body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments/source-network

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments/source-network

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)brg-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)port-mirror-configuration-assignments body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
**(config)contrail-vmi-params body
**(config)source-vnfc-instance-group-id body
**(config)dest-vnfc-instance-group-id body
**(config)source-to-dest-maps body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
(config)network-information-items body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
**(config)network-information-item body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
(config)vlan-vnfc-instance-groups body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
**(config)vlan-vnfc-instance-group body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-topology-identifier-structure/related-networks/related-network/{network-id}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
network-id path Key to l3-network object string
(config)vlan-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-topology-identifier-structure/related-networks/related-network/{network-id}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
network-id path Key to l3-network object string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-topology-identifier-structure/related-networks/related-network/{network-id}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
network-id path Key to l3-network object string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)network-topology body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
**(config)network-assignments body
**(config)network-parameters body
**(config)onap-model-information body
**(config)network-topology-identifier-structure body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
(config)network-topology-identifier-structure body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
**(config)related-networks body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

POST /operations/GENERIC-RESOURCE-API:getpathsegment-topology-operation

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
body body

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)request-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/provided-configurations

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
(config)provided-configurations body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/provided-configurations

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
**(config)provided-configuration body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/provided-configurations

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/provided-configurations

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-provided-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)network-provided-allotted-resources body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-provided-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-provided-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}/vnfc-ip-assignments/{vnfc-address-family}/vnfc-subnet-ip/{vnfc-ip-address}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string
vnfc-address-family path indicates if this is IpV4 or IpV6 string
vnfc-ip-address path Either IpV4 IP or IpV6 IP addresses should be present string
(config)vnfc-subnet-ip body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}/vnfc-ip-assignments/{vnfc-address-family}/vnfc-subnet-ip/{vnfc-ip-address}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string
vnfc-address-family path indicates if this is IpV4 or IpV6 string
vnfc-ip-address path Either IpV4 IP or IpV6 IP addresses should be present string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}/vnfc-ip-assignments/{vnfc-address-family}/vnfc-subnet-ip/{vnfc-ip-address}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string
vnfc-address-family path indicates if this is IpV4 or IpV6 string
vnfc-ip-address path Either IpV4 IP or IpV6 IP addresses should be present string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-oper-status

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

POST /operations/GENERIC-RESOURCE-API:security-zone-topology-operation

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
body body

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/service-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)service-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/service-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
**(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/service-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/service-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/gc-request-input/input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/gc-request-input/input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/gc-request-input/input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)tunnelxconn-allotted-resource body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)allotted-resource-data body
**(config)allotted-resource-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)param body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-resolution-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)port-mirror-configuration body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
**(config)configuration-data body
**(config)configuration-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string
(config)vnfc-subnet body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string
**(config)vnfc-ip-assignments body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
(config)vf-module-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/service-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)service-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/service-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
**(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/service-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/service-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/source-vnfc-instance-group-id

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)source-vnfc-instance-group-id body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/source-vnfc-instance-group-id

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/source-vnfc-instance-group-id

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/configuration-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/configuration-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/configuration-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-topology/tunnelxconn-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-topology/tunnelxconn-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-topology/tunnelxconn-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

POST /operations/GENERIC-RESOURCE-API:generic-configuration-notification

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
body body

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
(config)vm-network body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
**(config)network-information-items body
**(config)mac-addresses body
**(config)floating-ips body
**(config)interface-route-prefixes body
**(config)sriov-parameters body
**(config)related-networks body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
(config)network-information-items body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
**(config)network-information-item body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)request-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-common-ip-addresses/ip-addresses

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
(config)ip-addresses body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-common-ip-addresses/ip-addresses

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-common-ip-addresses/ip-addresses

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)sdnc-request-header body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-oper-status

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
(config)preload-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
(config)sub-interface-network-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
**(config)network-information-items body
**(config)floating-ips body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
(config)service-path body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
**(config)service body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/contrail-route-request-input/source-network

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)source-network body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/contrail-route-request-input/source-network

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/contrail-route-request-input/source-network

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vnf-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
(config)vnf-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vnf-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
**(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vnf-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vnf-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/sriov-parameters/heat-vlan-filters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
(config)heat-vlan-filters body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/sriov-parameters/heat-vlan-filters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/sriov-parameters/heat-vlan-filters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-request-input/vf-module-input-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
(config)vf-module-input-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-request-input/vf-module-input-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-request-input/vf-module-input-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-request-input/vf-module-input-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
(config)vnfs body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
**(config)vnf body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)allotted-resource-operation-information body
**(config)contrail-route-topology body
**(config)allotted-resource-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/availability-zones

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)availability-zones body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/availability-zones

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/availability-zones

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)request-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology/service-topology-identifier

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
(config)service-topology-identifier body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology/service-topology-identifier

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology/service-topology-identifier

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)vnf body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
**(config)vnf-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/tunnelxconn-request-input

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)tunnelxconn-request-input body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/tunnelxconn-request-input

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/tunnelxconn-request-input

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-topology/brg-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)brg-assignments body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-topology/brg-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-topology/brg-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology/service-parameters/service-parameter/{service-parameter-name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
service-parameter-name path string
(config)service-parameter body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology/service-parameters/service-parameter/{service-parameter-name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
service-parameter-name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology/service-parameters/service-parameter/{service-parameter-name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
service-parameter-name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/sriov-parameters/application-tags/s-tags

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
(config)s-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/sriov-parameters/application-tags/s-tags

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/sriov-parameters/application-tags/s-tags

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

GET /operational/GENERIC-RESOURCE-API:services

  • Produces: [u’application/json’, u’application/xml’]

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string
(config)param body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string
**(config)resource-resolution-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string

Responses

200 - No response was specified

GET /operational/GENERIC-RESOURCE-API:preload-information

  • Produces: [u’application/json’, u’application/xml’]

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:generic-configurations

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
(config)generic-configurations body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:generic-configurations

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
**(config)gc-configuration body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:generic-configurations

  • Produces: [u’application/json’, u’application/xml’]

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:generic-configurations

  • Produces: [u’application/json’, u’application/xml’]

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input/network-input-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)network-input-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input/network-input-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input/network-input-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input/network-input-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)connection-attachment-topology body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)connection-attachment-parameters body
**(config)connection-attachment-assignments body
**(config)allotted-resource-identifiers body
**(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/floating-ips

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
(config)floating-ips body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/floating-ips

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/floating-ips

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/allotted-resource-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics/vnic/{vnic-port-name}/sub-interfaces/sub-interface/{sub-interface-port-name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string
vnic-port-name path string
sub-interface-port-name path string
(config)sub-interface body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics/vnic/{vnic-port-name}/sub-interfaces/sub-interface/{sub-interface-port-name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string
vnic-port-name path string
sub-interface-port-name path string
**(config)sub-interface-ip-addresses body
**(config)sub-interface-network body
**(config)vlan-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics/vnic/{vnic-port-name}/sub-interfaces/sub-interface/{sub-interface-port-name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string
vnic-port-name path string
sub-interface-port-name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics/vnic/{vnic-port-name}/sub-interfaces/sub-interface/{sub-interface-port-name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string
vnic-port-name path string
sub-interface-port-name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/route-table-reference/{route-table-reference-fqdn}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
route-table-reference-fqdn path string
(config)route-table-reference body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/route-table-reference/{route-table-reference-fqdn}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
route-table-reference-fqdn path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/route-table-reference/{route-table-reference-fqdn}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
route-table-reference-fqdn path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/subnets-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
(config)subnets-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/subnets-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
**(config)subnet-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/subnets-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/subnets-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)security-zone-request-input body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)security-zone-input-parameters body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-status

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input/network-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input/network-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input/network-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs/vnf/{vnf-instance-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
vnf-instance-id path VNF instance ID in the path string
(config)vnf body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs/vnf/{vnf-instance-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
vnf-instance-id path VNF instance ID in the path string
**(config)vf-module-instance body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs/vnf/{vnf-instance-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
vnf-instance-id path VNF instance ID in the path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs/vnf/{vnf-instance-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
vnf-instance-id path VNF instance ID in the path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments/contrail-applied-service

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)contrail-applied-service body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments/contrail-applied-service

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments/contrail-applied-service

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-common-ip-addresses/ip-addresses

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
(config)ip-addresses body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-common-ip-addresses/ip-addresses

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-common-ip-addresses/ip-addresses

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string
(config)related-network body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string
**(config)vlan-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics/vnic/{vnic-port-name}/sub-interfaces/sub-interface/{sub-interface-port-name}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string
vnic-port-name path string
sub-interface-port-name path string
(config)vlan-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics/vnic/{vnic-port-name}/sub-interfaces/sub-interface/{sub-interface-port-name}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string
vnic-port-name path string
sub-interface-port-name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics/vnic/{vnic-port-name}/sub-interfaces/sub-interface/{sub-interface-port-name}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string
vnic-port-name path string
sub-interface-port-name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-policy/{network-policy-fqdn}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-policy-fqdn path string
(config)network-policy body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-policy/{network-policy-fqdn}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-policy-fqdn path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-policy/{network-policy-fqdn}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-policy-fqdn path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure/related-networks/related-network/{network-id}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-id path Key to l3-network object string
(config)vlan-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure/related-networks/related-network/{network-id}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-id path Key to l3-network object string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure/related-networks/related-network/{network-id}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-id path Key to l3-network object string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)vnf-sub-interface-groups body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
**(config)vnf-sub-interface-group body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-parameters-data/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-parameters-data/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-parameters-data/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-parameters-data/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/contrail-route-request-input/contrail-route-input-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)contrail-route-input-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/contrail-route-request-input/contrail-route-input-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/contrail-route-request-input/contrail-route-input-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/contrail-route-request-input/contrail-route-input-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
(config)service-paths body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
**(config)service-path body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs/vnf/{vnf-instance-id}/vf-module-instance

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
vnf-instance-id path VNF instance ID in the path string
(config)vf-module-instance body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs/vnf/{vnf-instance-id}/vf-module-instance

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
vnf-instance-id path VNF instance ID in the path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}/vnfs/vnf/{vnf-instance-id}/vf-module-instance

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
vnf-instance-id path VNF instance ID in the path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input/security-zone-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input/security-zone-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input/security-zone-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input/security-zone-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
(config)vf-module-assignments body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
**(config)vms body
**(config)vlan-vnfc-instance-groups body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items/network-information-item/{ip-version}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
ip-version path Use ipv4 or ipv6 string
(config)network-information-item body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items/network-information-item/{ip-version}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
ip-version path Use ipv4 or ipv6 string
**(config)network-ips body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items/network-information-item/{ip-version}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
ip-version path Use ipv4 or ipv6 string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items/network-information-item/{ip-version}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
ip-version path Use ipv4 or ipv6 string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
(config)vnf-resource-assignments body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
**(config)availability-zones body
**(config)vnf-networks body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-topology-identifier-structure/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
network-id path Key to l3-network object string
(config)related-network body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-topology-identifier-structure/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
network-id path Key to l3-network object string
**(config)vlan-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-topology-identifier-structure/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
network-id path Key to l3-network object string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-topology-identifier-structure/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
network-id path Key to l3-network object string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
(config)vm-names body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
**(config)vnfc-names body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string
(config)param body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string
**(config)resource-resolution-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/connection-attachment-request-input/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/connection-attachment-request-input/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/connection-attachment-request-input/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/connection-attachment-request-input/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/connection-point/vlan-data/{vlan-uuid}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vlan-uuid path Key to vlan-tag uuid object in A&AI Generated by vlan mS string
(config)vlan-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/connection-point/vlan-data/{vlan-uuid}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vlan-uuid path Key to vlan-tag uuid object in A&AI Generated by vlan mS string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/connection-point/vlan-data/{vlan-uuid}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vlan-uuid path Key to vlan-tag uuid object in A&AI Generated by vlan mS string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-request-input/service-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
name path string
(config)param body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-request-input/service-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
name path string
**(config)resource-resolution-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-request-input/service-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-request-input/service-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
(config)vf-module-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
**(config)vf-module-level-oper-status body
**(config)sdnc-request-header body
**(config)request-information body
**(config)vf-module-request-input body
**(config)vf-module-information body
**(config)service-information body
**(config)vnf-information body
**(config)vf-module-topology body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
(config)vlan-vnfc-instance-group body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
**(config)vnfcs body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/request-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
(config)request-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/configuration-identifiers

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)configuration-identifiers body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/configuration-identifiers

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/configuration-identifiers

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
(config)forwarding-paths body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
**(config)forwarding-path body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-request-input/vf-module-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-request-input/vf-module-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-request-input/vf-module-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-request-input/vf-module-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-topology-identifier

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
(config)vf-module-topology-identifier body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-topology-identifier

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-topology-identifier

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string
(config)network-information-items body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string
**(config)network-information-item body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
(config)related-networks body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
**(config)related-network body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)tunnelxconn-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/availability-zones

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
(config)availability-zones body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/availability-zones

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/availability-zones

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
(config)param body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
**(config)resource-resolution-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
(config)vf-module-assignments body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
**(config)vms body
**(config)vlan-vnfc-instance-groups body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-level-oper-status

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)vnf-level-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-level-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-level-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
(config)vm-network body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
**(config)network-information-items body
**(config)mac-addresses body
**(config)floating-ips body
**(config)interface-route-prefixes body
**(config)sriov-parameters body
**(config)related-networks body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
(config)related-networks body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
**(config)related-network body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/configuration-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/configuration-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/configuration-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)param body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-resolution-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-oper-status

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)configuration-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
(config)sub-interface-network-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
**(config)network-information-items body
**(config)floating-ips body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)param body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-resolution-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/contrail-vmi-params

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)contrail-vmi-params body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/contrail-vmi-params

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/contrail-vmi-params

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/contrail-vmi-params

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/network-information-items/network-information-item/{ip-version}/network-ips

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
ip-version path Use ipv4 or ipv6 string
(config)network-ips body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/network-information-items/network-information-item/{ip-version}/network-ips

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
ip-version path Use ipv4 or ipv6 string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/network-information-items/network-information-item/{ip-version}/network-ips

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
ip-version path Use ipv4 or ipv6 string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/contrail-vmi-params/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/contrail-vmi-params/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/contrail-vmi-params/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-assignments/contrail-vmi-params/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string

Responses

200 - No response was specified

GET /operational/GENERIC-RESOURCE-API:contrail-route-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string
(config)related-network body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string
**(config)vlan-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/connection-point

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
(config)connection-point body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/connection-point

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
**(config)vlan-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/connection-point

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/connection-point

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
(config)vf-module-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/configuration-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)configuration-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/configuration-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
**(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/configuration-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/configuration-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/license-information/license-key-group-list/{license-key-group-uuid}/{action}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
license-key-group-uuid path string
action path string
(config)license-key-group-list body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/license-information/license-key-group-list/{license-key-group-uuid}/{action}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
license-key-group-uuid path string
action path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/license-information/license-key-group-list/{license-key-group-uuid}/{action}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
license-key-group-uuid path string
action path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-oper-status

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-status

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/service-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/service-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/service-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/service-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/service-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/service-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)network-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
**(config)network-parameter body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-topology/network-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-level-oper-status

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
(config)vf-module-level-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-level-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-level-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)network body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
**(config)network-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/port-mirror-configuration-topology/port-mirror-configuration-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
(config)preload-list body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
**(config)preload-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-topology/brg-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-topology/brg-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/brg-topology/brg-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
(config)preload-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
**(config)preload-oper-status body
**(config)preload-network-topology-information body
**(config)preload-vf-module-topology-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/dest-port

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)dest-port body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/dest-port

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
**(config)vnf-information body
**(config)pnf-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/dest-port

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/dest-port

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)security-zone-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
(config)preload-network-topology-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
**(config)route-table-reference body
**(config)network-policy body
**(config)vpn-bindings body
**(config)host-routes body
**(config)network-topology-identifier-structure body
**(config)subnets body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/sriov-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
(config)sriov-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/sriov-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
**(config)heat-vlan-filters body
**(config)application-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/sriov-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/sriov-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/subnets/{start-address}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
start-address path string
(config)subnets body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/subnets/{start-address}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
start-address path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/subnets/{start-address}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
start-address path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)vf-modules body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
**(config)vf-module body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)sdnc-request-header body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/brg-request-input

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)brg-request-input body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/brg-request-input

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/brg-request-input

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)request-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
(config)related-networks body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
**(config)related-network body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
(config)vnf-network body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
**(config)subnets-data body
**(config)related-networks body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/contrail-route-request-input/contrail-applied-service-info

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)contrail-applied-service-info body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/contrail-route-request-input/contrail-applied-service-info

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/contrail-route-request-input/contrail-applied-service-info

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)resource-resolution-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters/param/{name}/resource-resolution-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)sdnc-request-header body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string
(config)sub-interface-network-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string
**(config)network-information-items body
**(config)floating-ips body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)param body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-resolution-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
(config)vlan-vnfc-instance-groups body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
**(config)vlan-vnfc-instance-group body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-operation-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)request-information body
**(config)sdnc-request-header body
**(config)allotted-resource-information body
**(config)service-information body
**(config)brg-request-input body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/provided-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
(config)provided-allotted-resources body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/provided-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
**(config)provided-allotted-resource body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/provided-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/provided-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/subnets-data/subnet-data/{sdnc-subnet-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string
sdnc-subnet-id path Unique SDNC generated UUID of the subnet. Key into A&AI instance.This maps to ipv4-key-subnet-id and ipv6-key-subnet-id in VNF-API string
(config)subnet-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/subnets-data/subnet-data/{sdnc-subnet-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string
sdnc-subnet-id path Unique SDNC generated UUID of the subnet. Key into A&AI instance.This maps to ipv4-key-subnet-id and ipv6-key-subnet-id in VNF-API string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/subnets-data/subnet-data/{sdnc-subnet-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string
sdnc-subnet-id path Unique SDNC generated UUID of the subnet. Key into A&AI instance.This maps to ipv4-key-subnet-id and ipv6-key-subnet-id in VNF-API string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
(config)vnic-group body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
**(config)vlan-common-ip-addresses body
**(config)vlan-vnics body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)network-request-input body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
**(config)network-input-parameters body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-request-input

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
(config)service-topology body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
**(config)service-topology-identifier body
**(config)onap-model-information body
**(config)service-assignments body
**(config)service-parameters body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-id path Key to l3-network object string
(config)related-network body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-id path Key to l3-network object string
**(config)vlan-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-id path Key to l3-network object string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-network-topology-information/network-topology-identifier-structure/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-id path Key to l3-network object string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)param body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-resolution-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)connection-attachment-allotted-resource body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)allotted-resource-data body
**(config)allotted-resource-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments/dest-network

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)dest-network body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments/dest-network

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments/dest-network

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/floating-ips

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string
(config)floating-ips body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/floating-ips

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-vnics/vlan-vnic/{vnic-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/floating-ips

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
vnic-port-id path string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string
(config)vlan-vnfc-instance-group body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string
**(config)vnfcs body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
instance-group-id path A&AI ID string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)contrail-route-assignments body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)source-network body
**(config)dest-network body
**(config)contrail-applied-service body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string
(config)vnics body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string
**(config)vnic body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-sub-interface-groups/vnf-sub-interface-group/{vnfc-instance-group-function}/{network-instance-group-function}/{parent-port-role}/vnfcs/vnfc/{vnfc-name}/vnics

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vnfc-instance-group-function path string
network-instance-group-function path string
parent-port-role path string
vnfc-name path Vnfc name as key in A&AI string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/floating-ips

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
(config)floating-ips body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/floating-ips

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/floating-ips

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/connection-attachment-request-input/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
(config)param body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/connection-attachment-request-input/param/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
**(config)resource-resolution-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/connection-attachment-request-input/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/connection-attachment-request-input/param/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string

Responses

200 - No response was specified

GET /operational/GENERIC-RESOURCE-API:port-mirror-configurations

  • Produces: [u’application/json’, u’application/xml’]

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}/vnfc-objects/vnfc-object/{vnfc-key}/vnics/vnic/{vnic-port-name}/vnic-ip-addresses

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string
vnfc-key path string
vnic-port-name path string
(config)vnic-ip-addresses body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}/vnfc-objects/vnfc-object/{vnfc-key}/vnics/vnic/{vnic-port-name}/vnic-ip-addresses

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string
vnfc-key path string
vnic-port-name path string
**(config)ip-addresses body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}/vnfc-objects/vnfc-object/{vnfc-key}/vnics/vnic/{vnic-port-name}/vnic-ip-addresses

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string
vnfc-key path string
vnic-port-name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}/vnfc-objects/vnfc-object/{vnfc-key}/vnics/vnic/{vnic-port-name}/vnic-ip-addresses

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string
vnfc-key path string
vnic-port-name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-operation-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)request-information body
**(config)sdnc-request-header body
**(config)allotted-resource-information body
**(config)security-zone-request-input body
**(config)service-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)security-zone-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-topology/security-zone-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

POST /config

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
**(config)services body
**(config)contrail-route-allotted-resources body
**(config)security-zone-allotted-resources body
**(config)tunnelxconn-allotted-resources body
**(config)brg-allotted-resources body
**(config)connection-attachment-allotted-resources body
**(config)port-mirror-configurations body
**(config)generic-configurations body
**(config)preload-information body

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-common-ip-addresses

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
(config)vlan-common-ip-addresses body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-common-ip-addresses

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string
**(config)ip-addresses body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-common-ip-addresses

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vlan-vnfc-instance-groups/vlan-vnfc-instance-group/{instance-group-id}/vnfcs/vnfc/{vnfc-name}/vnic-groups/vnic-group/{vnic-interface-role}/vlan-common-ip-addresses

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
instance-group-id path A&AI ID string
vnfc-name path string
vnic-interface-role path Same as network-role of network where vnic is connected string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string
(config)vlan-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks/vnf-network/{network-role}/related-networks/related-network/{network-id}/vlan-tags

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
network-role path A Network Role to which a VNF must connect string
network-id path Key to l3-network object string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input/security-zone-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input/security-zone-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/security-zone-request-input/security-zone-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)connection-attachment-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/connection-attachment-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-operation-information body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)request-information body
**(config)sdnc-request-header body
**(config)service-information body
**(config)connection-attachment-request-input body
**(config)allotted-resource-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
(config)connection-attachment-allotted-resources body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
**(config)connection-attachment-allotted-resource body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string
(config)related-networks body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string
**(config)related-network body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vnf-resource-assignments/vnf-networks/vnf-network/{network-role}/related-networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
network-role path A Network Role to which a VNF must connect string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)allotted-resource-operation-information body
**(config)security-zone-topology body
**(config)security-zone-parameters body
**(config)allotted-resource-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)request-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:brg-allotted-resources/brg-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-operation-information/request-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

GET /operational/GENERIC-RESOURCE-API:generic-configurations

  • Produces: [u’application/json’, u’application/xml’]

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)vnf-networks body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
**(config)vnf-network body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input/vnf-networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/networks/network/{network-id}/customer-bonding-requests

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
network-id path Index into network-topology-identifier structure string
(config)customer-bonding-requests body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/networks/network/{network-id}/customer-bonding-requests

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
network-id path Index into network-topology-identifier structure string
**(config)customer-bonding-request body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/networks/network/{network-id}/customer-bonding-requests

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
network-id path Index into network-topology-identifier structure string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/networks/network/{network-id}/customer-bonding-requests

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
network-id path Index into network-topology-identifier structure string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)vnf-request-input body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
**(config)vnf-networks body
**(config)vnf-network-instance-group-ids body
**(config)vnf-input-parameters body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-request-input

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/gc-request-input/input-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)input-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/gc-request-input/input-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/gc-request-input/input-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:generic-configurations/gc-configuration/{configuration-id}/configuration-data/configuration-operation-information/gc-request-input/input-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items/network-information-item/{ip-version}/network-ips

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
ip-version path Use ipv4 or ipv6 string
(config)network-ips body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items/network-information-item/{ip-version}/network-ips

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
ip-version path Use ipv4 or ipv6 string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-ports/vnfc-port/{vnfc-port-id}/vnic-sub-interfaces/sub-interface-network-data/{network-id}/network-information-items/network-information-item/{ip-version}/network-ips

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-port-id path Port(s) with a given network-role are assigned vnfc-port-id from series - 01, 02, 03 …Example: VM with two ports with network-role =X and another 2 ports with network-role=Y vnfc-port-ids:01 - 1st port with network-role=X02 - 2nd port with network-role=X01 - 1st port with network-role=Y02 - 2nd port with network-role=Y string
network-id path Subinterface network id (UUID in A&AI) string
ip-version path Use ipv4 or ipv6 string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/contrail-route-topology/contrail-route-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology/service-assignments

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
(config)service-assignments body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology/service-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/service-topology/service-assignments

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-level-oper-status

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)network-level-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-level-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data/network-level-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/license-information/entitlement-pool-list/{entitlement-pool-uuid}/{action}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
entitlement-pool-uuid path string
action path string
(config)entitlement-pool-list body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/license-information/entitlement-pool-list/{entitlement-pool-uuid}/{action}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
entitlement-pool-uuid path string
action path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/license-information/entitlement-pool-list/{entitlement-pool-uuid}/{action}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
entitlement-pool-uuid path string
action path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-topology/tunnelxconn-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)tunnelxconn-parameters body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-topology/tunnelxconn-parameters

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-topology/tunnelxconn-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:tunnelxconn-allotted-resources/tunnelxconn-allotted-resource/{allotted-resource-id}/allotted-resource-data/tunnelxconn-topology/tunnelxconn-parameters

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:security-zone-allotted-resources/security-zone-allotted-resource/{allotted-resource-id}/allotted-resource-data/security-zone-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-parameters-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)vnf-parameters-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-parameters-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
**(config)param body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-parameters-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-parameters-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-oper-status

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:contrail-route-allotted-resources/contrail-route-allotted-resource/{allotted-resource-id}/allotted-resource-data/allotted-resource-oper-status

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
(config)service body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string
**(config)vnfs body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/forwarding-paths/forwarding-path/{forwarding-path-id}/service-paths/service-path/{service-path-instance-id}/service/{service-instance-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
forwarding-path-id path Generated by SDNC string
service-path-instance-id path Service path instance ID generated by SDNC. Identifies a service-path-instance within a forwarding-path definition string
service-instance-id path service-instance-id of each service-instance in the service-path-instance string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
network-id path Key to l3-network object string
(config)related-network body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
network-id path Key to l3-network object string
**(config)vlan-tags body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
network-id path Key to l3-network object string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:preload-information/preload-list/{preload-id}/{preload-type}/preload-data/preload-vf-module-topology-information/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-networks/vm-network/{network-role}/related-networks/related-network/{network-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
preload-id path vf-module-name or network name string
preload-type path network or vf-module string
vm-type path string
network-role path network (identified by role) that this VM connects to. Should also be included in the vnf-networks for the containing VNF string
network-id path Key to l3-network object string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
(config)network-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string
**(config)network-provided-allotted-resources body
**(config)network-level-oper-status body
**(config)sdnc-request-header body
**(config)request-information body
**(config)service-information body
**(config)network-request-input body
**(config)network-information body
**(config)network-topology body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/networks/network/{network-id}/network-data

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}/vnfc-ip-assignments/{vnfc-address-family}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string
vnfc-address-family path indicates if this is IpV4 or IpV6 string
(config)vnfc-ip-assignments body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}/vnfc-ip-assignments/{vnfc-address-family}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string
vnfc-address-family path indicates if this is IpV4 or IpV6 string
**(config)vnfc-subnet-ip body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}/vnfc-ip-assignments/{vnfc-address-family}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string
vnfc-address-family path indicates if this is IpV4 or IpV6 string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/vnfc-subnet/{vnfc-subnet-role}/vnfc-ip-assignments/{vnfc-address-family}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vnfc-subnet-role path Default value if subnet role is not defined. string
vnfc-address-family path indicates if this is IpV4 or IpV6 string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/source-port/vnf-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/source-port/vnf-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/source-port/vnf-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/allotted-resource-identifiers

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-identifiers body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/allotted-resource-identifiers

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data/connection-attachment-topology/allotted-resource-identifiers

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-provided-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)vnf-provided-allotted-resources body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-provided-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-provided-allotted-resources

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-topology-identifier-structure

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)vnf-topology-identifier-structure body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-topology-identifier-structure

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology/vnf-topology-identifier-structure

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
(config)onap-model-information body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-information/onap-model-information

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/connection-point/vlan-data/{vlan-uuid}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vlan-uuid path Key to vlan-tag uuid object in A&AI Generated by vlan mS string
(config)vlan-data body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/connection-point/vlan-data/{vlan-uuid}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vlan-uuid path Key to vlan-tag uuid object in A&AI Generated by vlan mS string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vf-modules/vf-module/{vf-module-id}/vf-module-data/vf-module-topology/vf-module-assignments/vms/vm/{vm-type}/vm-names/vnfc-names/{vnfc-name}/vnfc-networks/vnfc-network-data/{vnfc-network-role}/connection-point/vlan-data/{vlan-uuid}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
vf-module-id path string
vm-type path string
vnfc-name path string
vnfc-network-role path string
vlan-uuid path Key to vlan-tag uuid object in A&AI Generated by vlan mS string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
(config)networks body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/networks

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
**(config)network body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}/networks

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
name path string
(config)resource-key body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
name path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:port-mirror-configurations/port-mirror-configuration/{configuration-id}/configuration-data/configuration-operation-information/port-mirror-configuration-request-input/port-mirror-configuration-input-parameters/param/{name}/resource-resolution-data/resource-key/{name}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
configuration-id path string
name path string
name path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}/vnfc-objects

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string
(config)vnfc-objects body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}/vnfc-objects

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string
**(config)vnfc-object body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}/vnfc-objects

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}/vnfc-objects

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)sdnc-request-header body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/sdnc-request-header

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
(config)vnf-topology body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string
**(config)vnf-parameters-data body
**(config)vnf-topology-identifier-structure body
**(config)onap-model-information body
**(config)vnf-resource-assignments body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfs/vnf/{vnf-id}/vnf-data/vnf-topology

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
vnf-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
(config)network-instance-group body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string
**(config)subnet-assignment-policy body
**(config)vpn-binding-policy body
**(config)networks body
**(config)onap-model-information body
**(config)subnets body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/network-instance-groups/network-instance-group/{network-instance-group-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
network-instance-group-id path Also a Key in Network Instance Group in A&AI string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string
(config)vnfc-instance-group body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string
**(config)vnfc-objects body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string

Responses

200 - No response was specified

DELETE /config/GENERIC-RESOURCE-API:services/service/{service-instance-id}/service-data/vnfc-instance-groups/vnfc-instance-group/{instance-group-role}/{nfc-naming-code}/{configuration-id}

  • Produces: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
service-instance-id path Keep as M string
instance-group-role path i.e.TSBC_VNFC_group string
nfc-naming-code path Set to nfc-naming-code from A&AI string
configuration-id path string

Responses

200 - No response was specified

PUT /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
(config)allotted-resource-data body

Responses

200 - No response was specified

POST /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/connection-attachment-allotted-resource/{allotted-resource-id}/allotted-resource-data

  • Produces: [u’application/json’, u’application/xml’]
  • Consumes: [u’application/json’, u’application/xml’]

Parameters

Name Position Description Type
allotted-resource-id path string
**(config)allotted-resource-operation-information body
**(config)connection-attachment-topology body
**(config)connection-attachment-parameters body
**(config)allotted-resource-oper-status body

Responses

200 - No response was specified

GET /config/GENERIC-RESOURCE-API:connection-attachment-allotted-resources/c