Versions Compared

Key

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

DistributeTrafficCheck

This command runs a VNF check (post- or pre-check) for distribute traffic specifically and returns the result.

Target URL/restconf/operations/appc-provider-lcm:distribute-traffic-check
ActionDistributeTrafficCheck
Action-IdentifiersVnf-id
Payload ParametersSee below
Revision HistoryUnchanged in this release


Request Payload Parameters:
ParameterDescriptionRequired?Example
configuration-parametersA set of instance specific configuration parameters should be specified. If provided, APP-C replaces variables in the configuration template with the values supplied. The parameters are associated with request template defined with CDTYes

“payload”: “{"configuration-parameters": { "PlaybookName": "ansible_vfw_distributetraffic_check@0.00.yml", "NodeList": "[vfw-1]", "EnvParameters": { "IsPostCheck": true, "DtDestinations": [{ "vfw_ip": „192.168.10.110", "vsink_ip": „192.168.20.240" }]}, "Timeout": 3600 } }”


Exemplary CDT template for Ansible protocol:

{
    "PlaybookName": ${playbook},
    "NodeList": ${node_list},
    "EnvParameters": {
"IsPostCheck": true,
"DtDestinations": [{
"vfw_ip": „192.168.10.110",
"vsink_ip": „192.168.20.240"
}]
},
"Timeout": 3600
}

EnvParameters includes protocol specific parameters for Ansible playbook or Chef cookbook. Here with information if the Check is performed before or after traffic distribution and with further information about the distribution that will be performed (for PreCheck) or for the one that was already performed (PostCheck). EnvParameters has one mandatory parameters: "IsPostCheck" and the second one that is optional: "DtDestinations". Parameters in "DtDestinations" will depend on the VNF.

DistributeTrafficCheck Response

The response does not include any payload parameters.

Success: A successful distribute returns a success status code 400 after all traffic has been distributed.

Failure: A failed distribute check returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.