R4 API Document

DistributeTrafficCheck

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

^{Request Payload Parameters:}

Exemplary CDT template for Ansible protocol:

^{

       ^{"PlaybookName": ${playbook},}

       ^{"NodeList": ${node_list},}

       ^{"EnvParameters": {}

           ^{"IsPostCheck": ${is_post_check},}

           ^{"ConfigFileName": ${distribution_config_file}
       },}

       ^{"FileParameters": {}

           ^{${distribution_config_file} : ${distribution_config_file_content}
       },}

       ^{"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 (IsPostCheck) and with further information about the distribution that will be performed (PreCheck) or for the one that was already performed (PostCheck). EnvParameters has two mandatory parameters: "IsPostCheck" and the second one that folds information about name of file with configuration of traffic distrribution. FileParameters section specifies content of file that will be uploaded to Ansible server, the file will be loaded by playbook as Input parameters. This file holds information provided by the OOF in DistributeTraffic optimization Response: Traffic Distribution

DistributeTrafficCheck Response

The response does not include any payload parameters.

Success: A successful distribute check returns a success status code 400 when pre- or post- check conditions are satisfied

Success: A successful distribute check returns a success status code 401 when pre- or post- check conditions are not satisfied