12. ANNEX 4: Reference of NBI API Description
12.1. Introduction
OSM North Bound Interface is RESTful, following ETSI SOL005 standard. It admits both YAML/JSON formats.
By default, it serves https (auto-signed certificate) on port 9999. Bearer authentication (with token) is used. Basic authentication or no authentication is also possible changing nbi.cfg file.
For development purposes it admits web browser navigation using a basic http format.
12.2. Request headers
Accept: 'application/json','application/yaml' in most of the cases. Use ‘text/html’ for web navigation. Use 'text/plain','application/zip' for descriptor artifacts showing. This header field shall be present if the response is expected to have a non-empty message body.
Content-Type: 'application/json','application/yaml' for most of the cases. For packages uploading use 'application/gzip','application/zip','application/x-gzip','application/binary'. For descriptor artifacts it can be used 'text/plain'. This header field shall be present if the request has a non-empty message body.
Authorization: 'Bearer <token_id>'. The authorization token for the request. It is mandatory except when a token is requested.
Content-Range: '<first byte>-<last byte>0/<total>'. It allows uploading a descriptor by chunks.
Transaction-Id: '<id>'. When uploaded by chunk, the id returned by first chunk
Content-File-MD5: '<md5>'. MD5 of uploaded package.
Content-Filename: '<filename>'. Filename of the uploaded package.
Query-String-Format: '<yaml>'. Parses query string values using yaml format.
12.3. Response headers
Content-Type: 'application/json','application/yaml' is the more normal. 'text/html' when web navigation. 'application/gzip','text/plain' for descriptor artifacts
Location: '/<main_topic>/v1/<topic>/<id>'. Always that something is created, this header is present containing URL to this element.
WWW-Authenticate: 'Bearer realm="{}"'. When Authentication error is obtained.
**Retry-After**: ''. (Future releases)
12.4. RBAC
From Release SIX, operations are authorized via RBAC (Role Base Access Control). Each user and project is assigned with a set of roles, and some of them must grant the intended operation. If administrative query string is used (see next section), role must grant the use of it in addition to the operation.
Role permissions are organized in a hierarchical tree, separated by colon, optionally ending with the http operation. The value of False means not granted, meanwhile with True it is granted. If this permission is missing, the immediate hierarchical permission applies. When there is not hierarchical at all, the defined “default” permission applies, and if “default” is missing, not granted is assumed. See these examples initial roles; and role permissions for the list of RBAC permission with their operation. In following sections the RBAC permission granting this operation is indicated in brackets.
12.5. Query String
Query string has the format: '?key=value&key2=value2&...'.
For GET method it allows filtering with this format, follows SOL005 section 4.3.2:
query string := ?<simpleFilterExpr>["&"<simpleFilterExpr>]*
simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
op := "eq" | "neq" (or "ne") | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
equal (by default), not equal, greater than, less than, greater than or equal, less than or equal, contains, not contains
attrName := string. For filtering inside array, use the index element of the array, or add ANYINDEX to apply the filtering over the same array element
For PUT/POST/PATCH It allows override e.g. package content, with the values of this query string
12.5.1. Administrative Query String
Some special keys used for administration are:
FORCE(=True)(rbac:force). Forces and operation. It disables descriptor checking, dependency checking. For delete, it allows deleting things that cannot done in normal operation because dependency. But beware that forcing deletion will not deletes created things at VIM level.PUBLIC(=True)(rbac:public). Allows getting public descriptor or instances (apart from those belonging to the project used login). For write/update operations, it used for set or unset a descriptor as publicADMIN(rbac:admin). Allows making operations on behalf of different project(s) than the one used for login (=projectA,projectB,...). Also to show all descriptor or instances (justADMIN). For update operations..SET_PROJECT=ProjectA,ProjectB,...(rbac:set_project). Allows adding an existing descriptor or instance to a project portfolio with an update operation.
12.6. URL and Methods summary
North Bound Interface (O: OSM specific; X,5: SOL005 not OSM implemented yet; O5: OSM and SOL005, 3: SOL003 implemented)
URL: /osm GET POST PUT DELETE PATCH
/nsd/v1
/ns_descriptors_content O O
/<nsdInfoId> O O O O
/ns_descriptors O5 O5
/<nsdInfoId> O5 O5 5
/nsd_content O5 O5
/nsd O
/artifacts[/<artifactPath>] O
/pnf_descriptors 5 5
/<pnfdInfoId> 5 5 5
/pnfd_content 5 5
/subscriptions 5 5
/<subscriptionId> 5 X
/vnfpkgm/v1
/vnf_packages_content O O
/<vnfPkgId> O O
/vnf_packages O5 O5
/<vnfPkgId> O5 O5 5
/package_content O5 O5
/upload_from_uri X
/vnfd O5
/artifacts[/<artifactPath>] O5
/subscriptions X X
/<subscriptionId> X X
/nslcm/v1
/ns_instances_content O O
/<nsInstanceId> O O
/ns_instances 5 5
/<nsInstanceId> O5 O5
instantiate O5
terminate O5
action O
scale O5
heal 5
/ns_lcm_op_occs 5 5
/<nsLcmOpOccId> 5 5 5
cancel 05
/vnf_instances (also vnfrs for compatibility) O
/<vnfInstanceId> O
/subscriptions 5 5
/<subscriptionId> 5 X
/vnflcm/v1
/vnf_instances 3 3
/<vnfInstanceId> 3 3
instantiate 3
terminate 3
scale 3
/vnf_lcm_op_occs 3
/<vnfLcmOpOccId> 3
/subscriptions 3 3
/<subscriptionId> 3 3
/pdu/v1
/pdu_descriptors O O
/<id> O O O O
/admin/v1
/tokens O O
/<id> O O
/users O O
/<id> O O O O
/projects O O
/<id> O O
/vim_accounts (also vims for compatibility) O O
/<id> O O O
/wim_accounts O O
/<id> O O O
/sdns O O
/<id> O O O
/k8sclusters O O
/<id> O O O
/k8srepos O O
/<id> O
/nst/v1 O O
/netslice_templates_content O O
/<nstInfoId> O O O O
/netslice_templates O O
/<nstInfoId> O O O
/nst_content O O
/nst O
/artifacts[/<artifactPath>] O
/subscriptions X X
/<subscriptionId> X X
/nsilcm/v1
/netslice_instances_content O O
/<SliceInstanceId> O O
/netslice_instances O O
/<SliceInstanceId> O O
instantiate O
terminate O
action O
/nsi_lcm_op_occs O O
/<nsiLcmOpOccId> O O O
/subscriptions X X
/<subscriptionId> X X
query string:
Follows SOL005 section 4.3.2 It contains extra METHOD to override http method, FORCE to force.
simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
op := "eq" | "neq" (or "ne") | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
attrName := string
For filtering inside array, it must select the element of the array, or add ANYINDEX to apply the filtering over any
item of the array, that is, pass if any item of the array pass the filter.
It allows both ne and neq for not equal
TODO: 4.3.3 Attribute selectors
all_fields, fields=x,y,.., exclude_default, exclude_fields=x,y,...
(none)... same as “exclude_default”
all_fields... all attributes.
fields=<list>... all attributes except all complex attributes with minimum cardinality of zero that are not
conditionally mandatory, and that are not provided in <list>.
exclude_fields=<list>... all attributes except those complex attributes with a minimum cardinality of zero that
are not conditionally mandatory, and that are provided in <list>.
exclude_default... all attributes except those complex attributes with a minimum cardinality of zero that are not
conditionally mandatory, and that are part of the "default exclude set" defined in the present specification for
the particular resource
exclude_default and include=<list>... all attributes except those complex attributes with a minimum cardinality
of zero that are not conditionally mandatory and that are part of the "default exclude set" defined in the
present specification for the particular resource, but that are not part of <list>
Additionally it admits some administrator values:
FORCE: To force operations skipping dependency checkings
ADMIN: To act as an administrator or a different project
PUBLIC: To get public descriptors or set a descriptor as public
SET_PROJECT: To make a descriptor available for other project
Header field name Reference Example Descriptions
Accept IETF RFC 7231 [19] application/json Content-Types that are acceptable for the response.
This header field shall be present if the response is expected to have a non-empty message body.
Content-Type IETF RFC 7231 [19] application/json The MIME type of the body of the request.
This header field shall be present if the request has a non-empty message body.
Authorization IETF RFC 7235 [22] Bearer mF_9.B5f-4.1JqM The authorization token for the request.
Details are specified in clause 4.5.3.
Range IETF RFC 7233 [21] 1000-2000 Requested range of bytes from a file
Header field name Reference Example Descriptions
Content-Type IETF RFC 7231 [19] application/json The MIME type of the body of the response.
This header field shall be present if the response has a non-empty message body.
Location IETF RFC 7231 [19] http://www.example.com/vnflcm/v1/vnf_instances/123 Used in redirection, or when a
new resource has been created.
This header field shall be present if the response status code is 201 or 3xx.
In the present document this header field is also used if the response status code is 202 and a new resource was
created.
WWW-Authenticate IETF RFC 7235 [22] Bearer realm="example" Challenge if the corresponding HTTP request has not
provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization
token.
Accept-Ranges IETF RFC 7233 [21] bytes Used by the Server to signal whether or not it supports ranges for
certain resources.
Content-Range IETF RFC 7233 [21] bytes 21010-47021/ 47022 Signals the byte range that is contained in the
response, and the total length of the file.
Retry-After IETF RFC 7231 [19] Fri, 31 Dec 1999 23:59:59 GMT```
12.7. Administrative Content Details
/admin/v1/tokens. Token is a temporal authorization for a user in a concrete project. Each request must contain it in the http header Authorization
GET: List the valid granted tokens obtained by this user
POST: Obtain a token. The ‘username’ and ‘password’ is mandatory only if http header does not contain Authorization. ‘project’ can be provided, if not, first project of available for this user is assigned. For changing project, a new token must be obtained.
Example of request content:
'{username: <user>, password: <pass>, project_id: <project>}'
/admin/v1/tokens/ID
GET: show token details
DELETE: revoque token. Logout
/admin/v1/users. (rbac: users). Users may operate in several projects
GET: Get user list
POST: Add a new user.
Example of request content:
'{username: <user>, password: <pass>, projects: [P1, P2, ...]}'
/admin/v1/users/ID. (rbac: users:id).
GET: Get user details
PUT/PATCH: Edit user. Example of user edition:
Change password:
'{password: <new_pass>}'Add role R1, projects P1:
'{add_project_role_mappings: [{project: role: R1}, ...]}'Remove role R1, project P1 from user:
{remove_project_role_mappings: [{project: P1, role: R1}]}'Remove a project ‘P1’ (all roles) from user:
{remove_project_role_mappings: [{project: P1}]}'Enforce password change on first login or password expiry:
'{old_password: <old_pass>, password: <new_pass>}'Unlock user:
'{system_admin_id: <system_admin_id>, unlock: true}'Renew user:
'{system_admin_id: <system_admin_id>, renew: true}'
DELETE: Removes user.
/admin/v1/projects. (rbac: projects). A project contains its own separate space
GET: Get project list
POST: Add a new project. Example of request content:
'{name: <P-name>, admin: <True/False>}'
/admin/v1/projects/ID. (rbac: projects:id)
GET: Get project details
PUT/PATCH: Edit project.Example of project edition to change admin status:
'{admin: <True/False>}'DELETE: Removes project.
/admin/v1/vim_accounts. (rbac: vims). Vim account is the deployment target
GET: Get vim_accounts
POST: Add a new vim_accounts.Example of request content:
name: ost2
vim_url: http://vim-server:vim-port/version
vim_type: openstack
vim_user: user
vim_password: password
vim_tenant_name: tenant
/admin/v1/vim_accounts/ID. (rbac: vims:id)
GET: Get vim_account details
PUT/PATCH: Edit vim_account. Example of vim_account edition:
vim_user: new-user
vim_password: new-password
vim_tenant_name: new-tenant
DELETE: Removes vim_account.
/admin/v1/wim_accounts. (rbac: wims). WIM are WAN Infrastructure Managers, that is in charge of inter VIM connectivity management
GET: Get wim_accounts
POST: Add a new wim_account. Example of request content:
name: wim-name
wim_url: http://wim-server:wim-port/version
wim_type: onosof
/admin/v1/wim_accounts/ID. (rbac: wims:id)
GET: Get wim_account details
PUT/PATCH: Edit wim_account. Example of wim_account edition:
wim_url: http://new-server:new-port/new-version
wim_type: new-type
DELETE: Removes wim_account.
/admin/v1/sdns. (rbac: sdn_controllers). SDN controllers in charge of VIM’s underlay connectivity in SDN Assist
GET: Gets sdn controller list
POST: Add a new sdn. Example of request content:
name: sdn-name
type: onosof
url: "10.95.172.251:8181"
config: {dpid: "00:00:28:99:3a:43:38:a1"}
user: username
password: password
/admin/v1/sdns/ID. (rbac: sdn_controllers:id)
GET: Get sdn details
PUT/PATCH: Edit sdn. Example of sdn edition:
type: odlof
url: http://10.96.125.234:8080
config: {dpid: "00:00:29:88:1b:55:27:c4"}
DELETE: Removes sdn.
/admin/v1/k8sclusters. (rbac: k8sclusters). K8S Clusters to deploy juju bundles or helm packages
GET: Gets k8s cluster list
POST: Add a new k8s cluster. Example of request content:
name: "k8s-cluster-name"
credentials:
apiVersion: v1
clusters:
- cluster:
certificate-authority-data: "LS0tLS1CRUdJTi...LS0tLQo="
server: "https://127.0.0.1:16443"
name: "microk8s-cluster"
contexts:
- context:
cluster: "microk8s-cluster"
user: "admin"
name: microk8s
current-context: "microk8s"
kind: "Config"
preferences: {}
users:
- name: "admin"
user:
username: "admin"
password: "password"
vim_account: c13b32f0-270c-4589-8610-24caa4c0ddb4
k8s_version: "1.16"
nets: # kdu: VIM
mgmt: "mgmt-net"
mgmt2: null
/admin/v1/k8sclusters/ID. (rbac: k8sclusters:id)
GET: Get k8sclusters details
PUT/PATCH: Edit k8sclusters. Example of k8scluster edition:
k8s_version: "1.17"
nets:
internal: int-net
external: ext-net
description: K8sCluster description text
DELETE: Removes k8sclusters.
/admin/v1/k8srepos. (rbac: k8srepos). K8S repository that contains the juju bundles or helm chart packages
GET: Gets k8s repositories
POST: Add a new k8s repository. Example of request content:
name: k8s-repo-name
type: helm-chart|juju-bundle
url: https://repo-server/path
/admin/v1/k8srepos/ID. (rbac: k8srepos:id)
GET: Get k8srepos details
DELETE: Removes k8srepos.
12.8. PDU Details
Physical Data Unit. This is catalogue of physical elements present at some vim_account/s. Deployment of a PNFD/HNFD implies using one of this pdu from the catalogue. Matching from PNFD/HNFD to PDU is done by ‘pdu.type’
/pdu/v1/pdu_descriptor. (rbac: pduds)
GET: List PDUs. Use query string for filtering.
POST: Create a new PDU. Example of request content:
name: descriptive name # mandatory
type: str # mandatory. maps VNFD.vdu.pdu-type
description: str
vim_accounts: [vim-account-id, ...] # mandatory
interfaces: # mandatory
- name: str # mandatory. Maps VNFD.vdu.interfaces.name
mgmt: boolean # mandatory. Indicates if is the management one
ip-address: ip # mandatory
vim-network-id: xxx
vim-network-name: xxx
/pdu/v1/pdu_descriptor/ID. (rbac: pduds:id)
GET: show PDU details
PUT: overwrite this PDU
PATCH: edit this PDU
DELETE: remove the PDU
12.9. VNFD Details
Virtual Network Function Descriptor. This includes also Physical and Hybrid Network Funcitons Descriptors (PNFD/HNFD). (At VDU level, it is indicated if it is physical with the 'pdu-type' information element).
See complete documentation on: Open OSM NBI in Swagger-UI
12.10. NSD Details
Network Services Descriptor
See complete documentation on: Open OSM NBI in Swagger-UI
12.11. NSLCM Details
Network Services Lifecycle Management
/nslcm/v1/ns_instances_content.
GET: (rbac:
ns_instances:get) Obtains a list of NSPOST: (rbac:
ns_instances:content:post) (Asynchronous). Creates and Instantiate a NS. It returns the nsInstanceId in the response header'Location'. Example of request content:
nsName: name # mandatory
nsdId: nsd-internal-id # mandatory
vimAccountId: internal-id # mandatory
wimAccountId: False/True/internal-id
additionalParamsForNs: {param1: value1, param2: value2}
additionalParamsForVnf: [member-vnf-index: "1", additionalParams: {param1: value1, param2: value2}]
ssh_keys: [ssh-key-pub1, ssh-key-pub2, ]
vnf: [ {member-vnf-index: "1", vimAccountId: vim-uuid, internal-vld: [], vdu: [] } ]
vld: [ {name: vld-name, ip-profile: {}, vnfd-connection-point-ref: [{}] }]
/nslcm/v1/ns_instances_content/ID. (rbac: ns_instances:id)
GET: Obtains details of a NS
DELETE: (Asynchronous) Terminates (or undeploy) and deletes (if termination is done successfully) a NS
/nslcm/v1/ns_instances. (rbac: ns_instances)
GET: Obtains a list of NS
POST: Creates a NS, but do not instantiate it. It returns the nsInstanceId in the response header
'Location'. Example of request content:
nsName: name # mandatory
nsdId: nsd-internal-id # mandatory
vimAccountId: internal-id # mandatory
wimAccountId: False/True/internal-id
additionalParamsForNs: {param1: value1, param2: value2}
additionalParamsForVnf: [member-vnf-index: "1", additionalParams: {param1: value1, param2: value2}]
/nslcm/v1/ns_instances/ID. (rbac: ns_instances:id)
GET: Obtains details of a NS
DELETE: Deletes a NS. It fails if NS is in ‘INSTANTIATED’ state
/nslcm/v1/ns_instances/ID/instantiate. (rbac: ns_instances:id:instantiate:post)
POST: (Asynchronous). Deploys a NS that it is in NOT_INSTANTIATED state. It returns the nsLcmOpOccId (Operations Occurrence Id) in the response header
'Location'. Example of request content:
vimAccountId: internal-id # mandatory
wimAccountId: False/True/internal-id
ssh_keys: [ssh-key-pub1, ssh-key-pub2, ]
vnf: [ {member-vnf-index: "1", vimAccountId: vim-uuid, internal-vld: [], vdu: [] } ]
vld: [ {name: vld-name, ip-profile: {}, vnfd-connection-point-ref: [{}] }]
/nslcm/v1/ns_instances/ID/terminate. (rbac: ns_instances:id:terminate:post)
POST: (Asynchronous). Undeploys a NS that it is in INSTANTIATED state. It returns the nsLcmOpOccId (Operations Occurrence Id) in the response header
'Location'
/nslcm/v1/ns_instances/ID/action. (rbac: ns_instances:id:action:post)
POST: (Asynchronous). Performs a Day-2 operation over the NS. It returns the nsLcmOpOccId (Operationts Occurence Id) in the response header
'Location'. Example of content to executing a primitive:
member_vnf_index: str # Needed for VNFD mapping NSD.constituent-vnfd.member-vnf-index. If missing a NSD is targeting
vdu_id: str # Needed if target is a VDU. Maps VNFD.vdu-id
vdu_count_index: int # Needed if the VDU has several replicas (count>1)
primitive: str # Mandatory. Maps [NSD.ns-configuration or VNFD.vnf-configuration or VNFD.vdu.vdu-configuration].config-primitive.name
primitive_params: dict # Optional. Maps [NSD.ns-configuration or VNFD.vnf-configuration or VNFD.vdu.vdu-configuration].config-primitive.parameter
param: value
...
/nslcm/v1/ns_instances/ID/scale. (rbac: ns_instances:id:scale:post)
POST: (Asynchronous). Performs a manual scale OUT/IN over one of the VNFs of the NS. It returns the nsLcmOpOccId (Operationts Occurence Id) in the response header
'Location'. Example of content:
scaleType: SCALE_VNF
scaleVnfData:
scaleVnfType: SCALE_OUT|SCALE_IN
scaleByStepData:
member-vnf-index: <nsd:constituent-vnfd:member-vnf-index>
scaling-group-descriptor: <vnfd:scaling-group-descriptor:name>
/nslcm/v1/ns_instances/nsi_lcm_op_occs. (rbac: ns_instances:opps)
GET: Obtains the list of Operations occurrences. It may be useful filtering by a concrete NS with
'?nsInstanceId=<nsInstaceId>'
/nslcm/v1/ns_instances/nsi_lcm_op_occs/ID. (rbac: ns_instances:opps:id)
GET: Show details of an Operations occurrences.
/nslcm/v1/vnf_instances. (rbac: vnf_instances). (also vnfrs for compatibility):
GET: Obtains the list of VNF. It may be useful filtering by a concrete NS with
'?nsr-id-ref=<nsInstaceId>'
/nslcm/v1/ID/vnf_instances/. (rbac: vnf_instances:id)
GET: Show details of a concrete VNF
12.12. NST Details
NetSlice Template descriptor
/nst/v1/netslice_templates_content
GET: (rbac:
slice_templates:get). Obtain list of Network Slice TemplatesPOST (rbac:
slice_templates:content:post). Create a Network Slice Template and upload the content
/nst/v1/netslice_templates_content/ID. (rbac: slice_templates:id)
GET: Show the detail of Network Slice Template
PUT: Update the whole Network Slice Template
DELETE: Remove a Network Slice template. The Network Slice template is removed only if state is
NOT_IN_USE.
/nst/v1/netslice_templates. (rbac: slice_templates)
GET: Obtain list of Network Slice Templates
POST: Create an empty Network Slice Template. A PUT should be done afterwards to upload the package
/nst/v1/netslice_templates/ID. (rbac: slice_templates:id)
GET: Show the detail of Network Slice Template descriptor used by OSM
DELETE: Remove a Network Slice Template. The Network Slice template is removed only if state is
NOT_IN_USE.PATCH: Update a Network Slice Template field
/nst/v1/netslice_templates/ID/nst_content. (rbac: slice_templates:content)
GET: Show the detail of the source Network Slice Template package
PUT: Update a Network Slice Template
/nst/v1/netslice_templates/ID/nst. (rbac: slice_templates:id:nst)
GET: Show the detail of the source Network Slice Template descriptor
/nst/v1/netslice_templates/ID/artifacts[/]. (rbac: slice_templates:id:nst_artifact)
GET: Obtain Network Slice Templates Artifacts. This is useful for download the Network Slice Templates
12.13. NSILCM Details
NetSlice Instance Lifecycle Management
/nsilcm/v1/netslice_instances_content
GET: (rbac:
slice_instances:get). Obtain the list of Network Slice InstancesPOST: (rbac:
slice_instances:content:post) (Asynchronous). Creates and Instantiate a Network Slice Instance. It returns thenetsliceInstanceIdin the response header'Location'. Example of request content:
nstId: name of the Network Slice Template #mandatory
nsiName: name of the Network Slice Instance # mandatory
vimAccountId: internal-id # mandatory
ssh_keys: comma separated list of keys to inject to vnfs
nsiDescription: description of the Network Slice Instance
additionalParamsForNsi: {param: value, ...}
netslice-subnet: [ Same content as section #NSLCM_Details /nslcm/v1/ns_instances_content ],
netslice-vld:
- name: TEXT,
vim-network-name: TEXT or DICT with the name for each vim account: {vimAccountId: network-name, ...},
vim-network-id: TEXT or DICT with the id for each vim account {vimAccountId: network-id},
ip-profile: Profile of the vld
/nsilcm/v1/netslice_instances_content/ID. (rbac: slice_instances:id)
GET: Show details of a concrete Network Slice Instance
DELETE: (Asynchronous) Terminates (or
undeploy) and deletes (if termination is done successfully) a Network Slice Instance Record
/nsilcm/v1/netslice_instances. (rbac: slice_instances)
GET: Obtain the list of Network Slice Instances
POST: Create the Network Slice Instance but do not instantiate it. It returns the netsliceInstanceId in the response header
'Location'. Example of request content: Same content as section NSILCM Details /nsilcm/v1/netslice_instances_content
/nsilcm/v1/netslice_instances/ID. (rbac: slice_instances:id)
GET: Show details of a concrete Network Slice Instance
DELETE: Delete the Network Slice Instance Record, if it is not instantiated
/nsilcm/v1/netslice_instances/ID/instantiate. (rbac: slice_instances:id:instantiate:post)
POST: (Asynchronous). Deploys a Network Slice Instance that it is in
NOT_INSTANTIATEDstate. It returns thensiLcmOpOccId(Operations Occurrence Id) in the response header ‘Location’. Example of request content: Same content as section NSILCM Details /nsilcm/v1/netslice_instances_content
/nsilcm/v1/netslice_instances/ID/terminate. (rbac: slice_instances:id:terminate:post)
POST: (Asynchronous). Undeploys a Network Slice Instance that it is in
INSTANTIATEDstate. It returns thensLcmOpOccId(Operations Occurrence Id) in the response header'Location'
/nsilcm/v1/netslice_instances/nsi_lcm_op_occ. (rbac: slice_instances:opps)
GET: Obtain the list of Network Slice Instances operations. It may be useful filtering by a concrete NSI with
'?netsliceInstanceId=<netsliceInstanceId>'
/nsilcm/v1/netslice_instances/nsi_lcm_op_occ/ID. (rbac: slice_instances:opps:id)
GET: Show details of a concrete Network Slice Instance operation
12.14. VNFLCM Details
Since Release TWELVE, OSM supports the Or-Vnfm interface (SOL003) to allow life cycle operation of VNFs. With the support of [ETSI GS NFV-SOL003(https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf) API, OSM enables the ability to serve as independent VNFM that can be integrated with any other Orchestrator and can perform VNF Life cycle management operations.
Besides the addition of VNF lifecycle API calls to instantiate, scale and terminate the NF, this feature is complemented with the capability to subscribe to those events and be notified, in the same way that it was already supported for NS lifecycle events.
12.14.1. Virtual Network Function Lifecycle Management Operations
/vnflcm/v1/vnf_instances. (rbac: vnflcm_instances)
GET: Obtain the list of VNF Instances
POST: Creates a VNF, but do not instantiate it. It returns the vnfInstanceId in the response header
'Location'. Example of request content:
vnfdId: vnfd-internal-id # mandatory
vnfInstanceName: instance-name # mandatory
vimAccountId: vim-id # mandatory
vnfInstanceDescription: instance-description
additionalParams:
constituent-cpd-id: connection-point-ref
virtual-link-desc:
-
id: vld-name
mgmt-network: true
virtual-link-profile-id: vld-name
/vnflcm/v1/vnf_instances/ID. (rbac: vnflcm_instances:id)
GET: Show details of a concrete VNF Instance
DELETE: Deletes a VNF. It fails if VNF is in ‘INSTANTIATED’ state
/vnflcm/v1/vnf_instances/ID/instantiate. (rbac: vnflcm_instances:id:instantiate:post)
POST: (Asynchronous). Deploys a VNF that it is in NOT_INSTANTIATED state. It returns the vnfLcmOpOccId (Operations Occurrence Id) in the response header
'Location'. Example of request content:
vnfName: instance-name # mandatory
vnfId: vnfd-id # mandatory
vimAccountId: vim-id # mandatory
vnfDescription: instance-description # mandatory
/vnflcm/v1/vnf_instances/ID/terminate. (rbac: vnflcm_instances:id:terminate:post)
POST: (Asynchronous). Undeploys a VNF that it is in INSTANTIATED state. It returns the vnfLcmOpOccId (Operations Occurrence Id) in the response header
'Location'. Example of request content:
terminationType: str
gracefulTerminationTimeout: int
/vnflcm/v1/vnf_instances/ID/scale. (rbac: vnflcm_instances:id:scale:post)
POST: (Asynchronous). Performs a manual scale OUT/IN of the VNF. It returns the vnfLcmOpOccId (Operations Occurence Id) in the response header
'Location'. Example of request content:
type: SCALE_OUT|SCALE_IN
aspectId: scaling-aspect-id
numberOfSteps: int
additionalParams:
member-vnf-index: member-vnf-index
/vnflcm/v1/vnf_instances/vnf_lcm_op_occs. (rbac: vnf_instances:opps)
GET: Obtain the list of VNF Instances operations
/vnflcm/v1/vnf_instances/vnf_lcm_op_occs/ID. (rbac: vnf_instances:opps:id)
GET: Show details of a concrete VNF Instance operation
12.14.2. VNFLCM Subscription and Notification support
/vnflcm/v1/subscriptions. (rbac: vnflcm_subscriptions)
GET: Obtain the list of subscriptions
POST: Creates a subscription. It returns the subscriptionId in the response header
'Location'. Example of request content:
Refer ETSI SOL003 document for filter options Page no 97
filter:
VnfInstanceSubscriptionFilter:
vnfdIds:
- hackfest_basic_metrics-vnf
notificationTypes:
- VnfLcmOperationOccurrenceNotification
operationTypes:
- INSTANTIATE
operationStates:
- PROCESSING
CallbackUri: "http://webhook.site/82b1d459-dce8-4ed2-bda1-360049d23bc1"
authentication:
authType: basic
paramsBasic:
userName: user
password: user
This payload implies that, for vnfd id hackfest_basic_metrics-vnf if operation state is PROCESSING and operation type is INSTANTIATE then, send a notification to http://webhook.site/82b1d459-dce8-4ed2-bda1-360049d23bc1 using the “authentication” mechanism whose payload is of datatype VnfLcmOperationOccurrenceNotification. Refer ETSI SOL003 document for notification reference Page no 102
Note: For detailed subscription and notification workflow refer (https://osm.etsi.org/docs/user-guide/latest/05-osm-usage.html#subscription-and-notification-support-in-osm)
/vnflcm/v1/subscriptions/ID. (rbac: vnflcm_subscriptions:id)
GET: Show details of a concrete VNF subscription
DELETE: Deletes a VNF subscription