+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
| **Parameter** | **Description** | **Required?** | **Example** |
+======================+===========================================================================================================================================================+=====================+==================================+
-| publish-config | \* If the publish\_config field is set to Y in the payload, then always send the running configuration from the VNF using the message bus | Yes | "publish-config": "<Y\|N>" |
+| publish-config | \* If the publish\-config field is set to Y in the payload, then always send the running configuration from the VNF using the message bus | Yes | "publish-config": "<Y\|N>" |
| | | | |
-| | \* If the publish\_config field is set to N in the payload, then: | | |
+| | \* If the publish\-config field is set to N in the payload, then: | | |
| | | | |
| | - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration | | |
| | | | |
| | be specified. | | |
+-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
+ConfigModify Request
+^^^^^^^^^^^^^^^^^^^^
+
+ Examples::
+
+ {
+ "input": {
+ "common-header": {
+ "timestamp": "2017-10-25T11:10:04.244Z",
+ "api-ver": "2.00",
+ "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
+ "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
+ "sub-request-id": "1",
+ "flags": {
+ "force": "TRUE",
+ "ttl": 60000
+ }
+ },
+ "action": "ConfigModify",
+ "action-identifiers": {
+ "vnf-id": "<VNF_ID>"
+ },
+ "payload": "{ \"config-url\":\"5f517fd4-bf3d-43bc-8147-1b61776d7ded\",
+ \"config-json\": \"{\"pg-streams\":{
+ \"pg-stream\": [{ \"id\":\"fw_udp1\", \"is-enabled\": \"true\" },
+ {\"id\": \"fw_udp2\", \"is-enabled\":\"true\" },
+ { \"id\": \"fw_udp3\",\"is-enabled\": \"true\" },
+ { \"id\":\"fw_udp4\", \"is-enabled\": \"true\" },
+ {\"id\": \"fw_udp5\", \"is-enabled\":\"true\" }]}}"
+ }
+ }
+ }
+
+
ConfigModify Response
^^^^^^^^^^^^^^^^^^^^^
DistributeTraffic
-----------------
-The Distribute traffic LCM action is used to distribute traffic across different instances of VNF, VNFC or VM.
-Entity for which Distribute Traffic LCM action is being invoked is called an anchor point that is responsible for final
+The Distribute Traffic LCM action is used to distribute traffic across different instances of VNF, VNFC or VM.
+The entity for which Distribute Traffic LCM action is being invoked is called an anchor point that is responsible for final
realization of request. Parameters present in configuration file specify where and how traffic should be distributed,
including: traffic destination points like VNFs, VNFCs or VMs; distribution weights; rollback strategy.
Format of configuration file is specific to each VNF type.
+--------------------------+--------------------------------------------------------------+
| **Action-identifiers** | vnf-id, vserver-id, vnfc-name |
+--------------------------+--------------------------------------------------------------+
-| **Payload Parameters** | ConfigFileName |
+| **Payload Parameters** | See below |
+--------------------------+--------------------------------------------------------------+
| **Revision History** | New in Casablanca |
+--------------------------+--------------------------------------------------------------+
Request Payload Parameters:
-+-----------------------+----------------------------------------------------------------------------------------------------+---------------------+--------------------------------------------------------+
-| **Parameter** | **Description** | **Required?** | **Example** |
-+=======================+====================================================================================================+=====================+========================================================+
-| ConfigFileName | Name of configuration file with additional parameters for Ansible playbook or Chef cookbook | | "payload": |
-| | with such parameters like traffic destinations, distribution weights or rollback strategy. | Yes | "{\\"ConfigFileName\\": \\"some-config.json\\"}” |
-+-----------------------+----------------------------------------------------------------------------------------------------+---------------------+--------------------------------------------------------+
++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------------------+
+| **Parameter** | **Description** | **Required?** | **Example** |
++=================================+==================================================================================================================================================================+=====================+===========================================================================+
+| configuration-parameters | A set of instance specific configuration parameters should be specified. If provided, APP-C replaces variables in the configuration template with the | No | "payload": |
+| | values supplied. The parameters are associated with request template defined with CDT | | "{\\"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.
DistributeTraffic Response
^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------------------+---------------------------------------------------+
| **Action-identifiers** | Vnf-id |
+------------------------------+---------------------------------------------------+
-| **Payload Parameters** | None |
+| **Payload Parameters** | See below |
+------------------------------+---------------------------------------------------+
| **Revision History** | Unchanged in this release. |
+------------------------------+---------------------------------------------------+
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
+| **Parameter** | **Description** | **Required?** | **Example** |
++======================+===========================================================================================================================================================+=====================+==================================+
+| publish-config | \* If the publish\-config field is set to Y in the payload, then always write the running configuration to file | Yes | "publish-config": "<Y\|N>" |
+| | | | |
+| | \* If the publish\-config field is set to N in the payload, then running configuration is not written to the file | | |
+| | | | |
++----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
+
+
Unlock
------
Code Review / appc.git / blobdiff