Versions Compared

Key

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

DistributeTrafficHealthCheck

This command runs a VNF health check for distribute traffic specifically and returns the result.


Target URL/restconf/operations/appc-provider-lcm:distribute-traffic-health-check
ActionHealthCheck
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 CDTNo“payload”: “{"configuration-parameters":{ "config_file_name":"/opt/onap/ccsdk/Playbooks/dt/config", "playbook":"ansible_vfw_distributetraffic@0.00.yml", "node_list":"[vpkg-1]" } }”


Exemplary CDT template for Ansible protocol:

{
    "PlaybookName": ${playbook},
    "NodeList": ${node_list},
    "EnvParameters": {
        "ConfigFileName": "${config_file_name}"
     },
    "Timeout": 3600
}

EnvParameters includes protocol specific parameters, here with name of configuration file having additional parameters for Ansible playbook or Chef cookbook. Distribute Traffic config file can have such parameters like traffic destinations, distribution weights or rollback strategy.

DistributeTrafficHealthCheck 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 returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.