Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ConfigScaleOut API Definition 

Note: This is temporary documentation for M2-  LCM API Guide will be updated when everything is finalized.

ConfigScaleOut

The ConfigScaleOut command is used to apply any actions on a VNF as part of a ScaleOut flow.     Actions could include updating the VNF configuration or running a set of other tasks.

The ConfigScaleOut action can have multiple APP-C templates associated with it.  APP-C retrieves the vf-module-name from A&AI which is used as the unique identifier to select the correct APP-C template.

APP-C creates or updates VNFC records in A&AI for the newly instantiated VM’s.  The orchestration-status of the VNFC’s is set to CONFIGURED.

This action is supported via the Netconf (limited to configuration changes), Chef, and Ansible protocols.

...

Target URL

...

/restconf /operations/ appc-provider-lcm: config-scale-out

...

Action

...

ConfigScaleOut

...

Action-Identifiers

...

Vnf-id

...

Payload Parameters

...

See below

...

Revision History

...

New in Beijing

Request Payload Parameters:

...

Payload

 Parameter

...

Description

...

Required?

...

Example

...

request- parameters

...

vnf-host-ip-address: optional if Netconf or other direct interface to the VNF.   If not provided, the vnf-host-ip-address will be obtained from A&AI.

Vf-module-id:  used to determine the A&AI VM inventory associated with ConfigScaleOut.

No

Yes

...

"payload":

"{\"request-parameters

\": {

\"vnf-host-ip-address\": \”value\”,

\”vf-module-id\”: \”value\”

}

\"configuration- parameters\": {\"<CONFIG- PARAMS>\"}

Information on the ConfigScaleOut can be found on readthedocs:

...

configuration- parameters

...

A set of instance specific configuration parameters should be specified. If provided, APP-C replaces variables in the configuration template with the values supplied.

...

No

ConfigScaleOut Response:

Success:  

  • A successful ConfigScaleOut returns a success status code 400 when completed.

Failure:

...

APPC LCM API Guide