description: Management operations related to Performance Mangement of NS instances
- name: 'Physical Data Units (PDU)'
description: Management operations of PDUs
+ - name: 'Authentication'
+ description: Authentication operations
+ - name: 'Identity'
+ description: Management operations of users, projects and roles
+ - name: 'Infrastructure'
+ description: Management operations of VIM, VIM accounts, WIM and SDN controllers
+ - name: 'Repositories'
+ description: Management operations of repositories
- name: 'Admin'
description: Management operations of Administration items
'/admin/v1/tokens':
get:
tags:
+ - "Authentication"
- "Admin"
summary: Query information about multiple Tokens
description: Query information about multiple Tokens
$ref: '#/components/responses/UnexpectedError'
post:
tags:
+ - "Authentication"
- "Admin"
summary: Request a new Token
description: Request a new Token
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Authentication"
- "Admin"
summary: Delete the Token indicated in the Authorization Header
description: Delete the Token indicated in the Authorization Header
type: string
get:
tags:
+ - "Authentication"
- "Admin"
summary: Query information about an individual Token
description: Query information about an individual Token
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Authentication"
- "Admin"
summary: Delete the Token indicated as parameter
description: Delete the Token indicated as parameter
'/admin/v1/users':
get:
tags:
+ - "Identity"
- "Admin"
summary: Query information about multiple Users
description: Query information about multiple Users
$ref: '#/components/responses/UnexpectedError'
post:
tags:
+ - "Identity"
- "Admin"
summary: Create a new User
description: Create a new User
type: string
get:
tags:
+ - "Identity"
- "Admin"
summary: Query information about an individual User
description: Query information about an individual User
$ref: '#/components/responses/UnexpectedError'
patch:
tags:
+ - "Identity"
- "Admin"
summary: Modify a User
description: Modify a User
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Identity"
- "Admin"
summary: Delete a User
description: Delete a User
'/admin/v1/projects':
get:
tags:
+ - "Identity"
- "Admin"
summary: Query information about multiple Projects
description: Query information about multiple Projects
$ref: '#/components/responses/UnexpectedError'
post:
tags:
+ - "Identity"
- "Admin"
summary: Create a new Project
description: Create a new Project
type: string
get:
tags:
+ - "Identity"
- "Admin"
summary: Query information about an individual Project
description: Query information about an individual Project
$ref: '#/components/responses/UnexpectedError'
patch:
tags:
+ - "Identity"
- "Admin"
summary: Modify a Project
description: Modify a Project
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Identity"
- "Admin"
summary: Delete a Project
description: Delete a Project
'/admin/v1/roles':
get:
tags:
+ - "Identity"
- "Admin"
summary: Query information about multiple Roles
description: Query information about multiple Roles
$ref: '#/components/responses/UnexpectedError'
post:
tags:
+ - "Identity"
- "Admin"
summary: Create a new Role
description: Create a new Role
type: string
get:
tags:
+ - "Identity"
- "Admin"
summary: Query information about an individual Role
description: Query information about an individual Role
$ref: '#/components/responses/UnexpectedError'
patch:
tags:
+ - "Identity"
- "Admin"
summary: Modify a Role
description: Modify a Role
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Identity"
- "Admin"
summary: Delete a Role
description: Delete a Role
'/admin/v1/vims':
get:
tags:
+ - "Infrastructure"
- "Admin"
summary: Query information about multiple VIMs
description: Query information about multiple VIMs
$ref: '#/components/responses/UnexpectedError'
post:
tags:
+ - "Infrastructure"
- "Admin"
summary: Create a new VIM
description: Create a new VIM
format: uuid
get:
tags:
+ - "Infrastructure"
- "Admin"
summary: Query information about an individual VIM
description: Query information about an individual VIM
$ref: '#/components/responses/UnexpectedError'
patch:
tags:
+ - "Infrastructure"
- "Admin"
summary: Modify a VIM
description: Modify a VIM
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Infrastructure"
- "Admin"
summary: Delete a VIM
description: Delete a VIM
'/admin/v1/vim_accounts':
get:
tags:
+ - "Infrastructure"
- "Admin"
summary: Query information about multiple VIM Accounts
description: Query information about multiple VIM Accounts
$ref: '#/components/responses/UnexpectedError'
post:
tags:
+ - "Infrastructure"
- "Admin"
summary: Create a new VIM Account
description: Create a new VIM Account
format: uuid
get:
tags:
+ - "Infrastructure"
- "Admin"
summary: Query information about an individual VIM Account
description: Query information about an individual VIM Account
$ref: '#/components/responses/UnexpectedError'
patch:
tags:
+ - "Infrastructure"
- "Admin"
summary: Modify a VIM Account
description: Modify a VIM Account
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Infrastructure"
- "Admin"
summary: Delete a VIM Account
description: Delete a VIM Account
'/admin/v1/wim_accounts':
get:
tags:
+ - "Infrastructure"
- "Admin"
summary: Query information about multiple WIM Accounts
description: Query information about multiple WIM Accounts
$ref: '#/components/responses/UnexpectedError'
post:
tags:
+ - "Infrastructure"
- "Admin"
summary: Create a new WIM Account
description: Create a new WIM Account
format: uuid
get:
tags:
+ - "Infrastructure"
- "Admin"
summary: Query information about an individual WIM Account
description: Query information about an individual WIM Account
$ref: '#/components/responses/UnexpectedError'
patch:
tags:
+ - "Infrastructure"
- "Admin"
summary: Modify a WIM Account
description: Modify a WIM Account
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Infrastructure"
- "Admin"
summary: Delete a WIM Account
description: Delete a WIM Account
'/admin/v1/sdns':
get:
tags:
+ - "Infrastructure"
- "Admin"
summary: Query information about multiple SDNs
description: Query information about multiple SDNs
$ref: '#/components/responses/UnexpectedError'
post:
tags:
+ - "Infrastructure"
- "Admin"
summary: Create a new SDN
description: Create a new SDN
format: uuid
get:
tags:
+ - "Infrastructure"
- "Admin"
summary: Query information about an individual SDN
description: Query information about an individual SDN
$ref: '#/components/responses/UnexpectedError'
patch:
tags:
+ - "Infrastructure"
- "Admin"
summary: Modify a SDN
description: Modify a SDN
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Infrastructure"
- "Admin"
summary: Delete a SDN
description: Delete a SDN
'/admin/v1/k8sclusters':
get:
tags:
+ - "Infrastructure"
- "Admin"
summary: Query information about multiple K8s Clusters
description: Query information about multiple K8s Clusters
$ref: '#/components/responses/UnexpectedError'
post:
tags:
+ - "Infrastructure"
- "Admin"
summary: Create a new K8s Cluster
description: Create a new K8s Cluster
format: uuid
get:
tags:
+ - "Infrastructure"
- "Admin"
summary: Query information about an individual K8s Cluster
description: Query information about an individual K8s Cluster
$ref: '#/components/responses/UnexpectedError'
patch:
tags:
+ - "Infrastructure"
- "Admin"
summary: Modify a K8s Cluster
description: Modify a K8s Cluster
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Infrastructure"
- "Admin"
summary: Delete a K8s Cluster
description: Delete a K8s Cluster
'/admin/v1/k8srepos':
get:
tags:
+ - "Repositories"
- "Admin"
summary: Query information about multiple K8s Repos
description: Query information about multiple K8s Repos
$ref: '#/components/responses/UnexpectedError'
post:
tags:
+ - "Repositories"
- "Admin"
summary: Create a new K8s Repo
description: Create a new K8s Repo
format: uuid
get:
tags:
+ - "Repositories"
- "Admin"
summary: Query information about an individual K8s Repo
description: Query information about an individual K8s Repo
$ref: '#/components/responses/UnexpectedError'
delete:
tags:
+ - "Repositories"
- "Admin"
summary: Delete a K8s Repo
description: Delete a K8s Repo
additionalParamsForNs:
type: object
additionalProperties: true
- additionalParamsForVnf:
+ additionalParamsForVnf: &additionalparamsforvnf
type: array
items:
type: object
additionalParams:
type: object
additionalProperties: true
+ k8s-namespace:
+ type: string
+ description: |
+ use this namespace for all the KDU deployed in this VNF
+ (if any). By default it is used the id of the project
additionalParamsForVdu:
type: array
items:
properties:
kdu_name:
type: string
+ k8s-namespace:
+ type: string
+ description: use this namespace for this KDU
+ kdu_model:
+ type: string
additionalParams:
type: object
additionalProperties: true
required:
- kdu_name
- - additionalParams
+ minProperties: 2
additionalProperties: false
required:
- member-vnf-index
format: uuid
vduImage:
type: string
+ placement-engine:
+ type: string
+ description: |
+ To compute automatically the target VIM for each VNF based on
+ constrains, e.g. latency. Currently only 'PLA' is supported
+ placement-constraints:
+ type: object
+ additionalProperties: true
+ k8s-namespace:
+ type: string
+ timeout_ns_deploy:
+ type: integer
vnf:
type: array
items:
type: string
segmentation-id:
type: string
+ network-type:
+ type: string
+ sdn-ports:
+ description: |
+ connect additional ports to the created underlay SDN connectivity.
+ Normally for external connectivy.
+ type: array
+ items:
+ type: object
+ properties:
+ switch_id:
+ type: string
+ switch_port:
+ type: string
+ mac_address:
+ type: string
+ format: mac_address
+ vlan:
+ type: integer
+ additionalProperties: true
+ required:
+ - switch_id
+ - switch_port
+ minItems: 1
additionalProperties: false
internal-connection-point:
type: array
type: string
enum:
- SCALE_VNF
+ timeout_ns_scale:
+ description: timeout for the scale operation
+ type: integer
scaleVnfData:
type: object
properties:
properties:
scaling-group-descriptor:
type: string
+ scaling-policy:
+ type: string
member-vnf-index:
type: string
- additionalProperties: true
- additionalProperties: true
- additionalProperties: true
+ required:
+ - scaling-group-descriptor
+ - member-vnf-index
+ additionalProperties: false
+ required:
+ - scaleVnfType
+ - scaleByStepData
+ additionalProperties: false
+ required:
+ - scaleType
+ - scaleVnfData
+ additionalProperties: false
TerminateNsRequest:
type: object
properties:
- terminationTime:
- description: |
- Timestamp indicating the end time of the NS, i.e. the NS will be terminated
- automatically at this timestamp. Cardinality "0" indicates the NS termination
- takes place immediately.
- type: string
- format: date-time
+ timeout_ns_terminate:
+ description: timeout for terminate operation
+ type: integer
+ autoremove:
+ description: remove network service if termination end without error
+ type: boolean
+ skip_terminate_primitives:
+ description: Do not execute network service termination primitives
+ type: boolean
+ additionalProperties: false
ArrayOfNsInstance:
type: array
items:
properties:
primitive:
type: string
+ description: |
+ name of the primitive in the 'config-descriptor'. If the target is
+ a kdu it can be also 'status', 'rollback' or 'upgrade'
primitive_params:
+ description: parameters of this primitive
$ref: '#/components/schemas/KeyValuePairs'
- lcmOperationType:
- type: string
- nsInstanceId:
- type: string
- format: uuid
member_vnf_index:
type: string
+ description: provide if the target action is for a vnf, vdu or kdu
vdu_id:
type: string
+ description: provide if the target action is for a vdu
+ kdu_name:
+ type: string
+ description: provide if the target action is for a kdu
vdu_count_index:
type: integer
+ timeout_ns_action:
+ description: timeout for the day 1/2 operation
+ type: integer
required:
- primitive
- primitive_params
additionalParamsForNs:
type: object
additionalProperties: true
- additionalParamsForVnf:
- type: array
- items:
- type: object
- properties:
- member-vnf-index:
- type: string
- additionalParams:
- type: object
- additionalProperties: true
- additionalParamsForVdu:
- type: array
- items:
- type: object
- properties:
- vdu_id:
- type: string
- additionalParams:
- type: object
- additionalProperties: true
- required:
- - vdu_id
- - additionalParams
- additionalProperties: false
- additionalParamsForKdu:
- type: array
- items:
- type: object
- properties:
- kdu_name:
- type: string
- additionalParams:
- type: object
- additionalProperties: true
- required:
- - kdu_name
- - additionalParams
- additionalProperties: false
- required:
- - member-vnf-index
- minProperties: 2
- additionalProperties: false
+ additionalParamsForVnf: *additionalparamsforvnf
ssh_keys:
type: array
items:
type: integer
minimum: 0
nullable: false
- nsts:
+ slice_templates:
type: integer
minimum: 0
nullable: false
- pdus:
+ pduds:
type: integer
minimum: 0
nullable: false
- nsrs:
+ ns_instances:
type: integer
minimum: 0
nullable: false
- nsis:
+ slice_instances:
type: integer
minimum: 0
nullable: false
type: integer
minimum: 0
nullable: false
- sdns:
+ sdn_controllers:
+ type: integer
+ minimum: 0
+ nullable: false
+ k8sclusters:
+ type: integer
+ minimum: 0
+ nullable: false
+ k8srepos:
+ type: integer
+ minimum: 0
+ nullable: false
+ osmrepos:
type: integer
minimum: 0
nullable: false
type: integer
minimum: 0
nullable: true
- nsts:
+ slice_templates:
type: integer
minimum: 0
nullable: true
- pdus:
+ pduds:
type: integer
minimum: 0
nullable: true
- nsrs:
+ ns_instances:
type: integer
minimum: 0
nullable: true
- nsis:
+ slice_instances:
type: integer
minimum: 0
nullable: true
type: integer
minimum: 0
nullable: true
- sdns:
+ sdn_controllers:
+ type: integer
+ minimum: 0
+ nullable: true
+ k8sclusters:
+ type: integer
+ minimum: 0
+ nullable: true
+ k8srepos:
+ type: integer
+ minimum: 0
+ nullable: true
+ osmrepos:
type: integer
minimum: 0
nullable: true