InlineVnf_instancesVnfInstanceIdOperateRequestBody

This type represents request parameters for the "Operate VNF" operation.

JSON Example

{
    "changeStateTo": "string",
    "stopType": "string",
    "gracefulStopTimeout": 0
}

string

changeStateTo

Required

The desired operational state (i.e. started or stopped) to change the VNF to.

Possible values are : STARTED, STOPPED,

string

stopType

Optional

It signals whether forceful or graceful stop is requested. The "stopType" and "gracefulStopTimeout" attributes shall be absent, when the "changeStateTo" attribute is equal to "STARTED". The "gracefulStopTimeout" attribute shall be present, when the "changeStateTo" is equal to "STOPPED" and the "stopType" attribute is equal to "GRACEFUL". The "gracefulStopTimeout" attribute shall be absent, when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is equal to "FORCEFUL". The request shall be treated as if the "stopType" attribute was set to "FORCEFUL", when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is absent.

Possible values are : FORCEFUL, GRACEFUL,

integer

gracefulStopTimeout

Optional

The time interval (in seconds) to wait for the VNF to be taken out of service during graceful stop, before stopping the VNF. The "stopType" and "gracefulStopTimeout" attributes shall be absent, when the "changeStateTo" attribute is equal to "STARTED". The "gracefulStopTimeout" attribute shall be present, when the "changeStateTo" is equal to "STOPPED" and the "stopType" attribute is equal to "GRACEFUL". The "gracefulStopTimeout" attribute shall be absent, when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is equal to "FORCEFUL". The request shall be treated as if the "stopType" attribute was set to "FORCEFUL", when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is absent.

object

additionalParams

Optional

Additional parameters passed by the NFVO as input to the process, specific to the VNF of which the operation status is changed, as declared in the VNFD as part of "OperateVnfOpConfig".

Parameter To

Post Operate