diff options
author | mrpa <miruna.paun@enea.com> | 2021-07-12 12:49:34 +0200 |
---|---|---|
committer | Miruna Paun <mrpa@enea.se> | 2021-07-13 16:37:45 +0100 |
commit | 0b17f330442c6829e7752b3cba47f889a57aa18f (patch) | |
tree | c518d5788e66b2326364eb18c744248531ddf0c4 | |
parent | 312ad3828ac6a83b481a4846861bd801ecd325b8 (diff) | |
download | nfv-access-documentation-0b17f330442c6829e7752b3cba47f889a57aa18f.tar.gz |
Added in note for the verbose option.
Change-Id: I274c128d5cf954bcdb62b018d2d8a8f5863cec32
Signed-off-by: mrpa <miruna.paun@enea.com>
-rw-r--r-- | doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml index 6ce9f9c..f710ccb 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml | |||
@@ -868,6 +868,41 @@ Options: | |||
868 | -o, --display_output Display output of the method | 868 | -o, --display_output Display output of the method |
869 | --help Show this message and exit.</programlisting> | 869 | --help Show this message and exit.</programlisting> |
870 | 870 | ||
871 | <para>For displaying all the available Python APIs and their parameters, | ||
872 | run the Python script with the <literal>-v/--verbose</literal> option. A | ||
873 | few examples will be displayed in the following sections.</para> | ||
874 | |||
875 | <para>If the parameters of the Python APIs contain <literal>=</literal> | ||
876 | in their description that means they have a default value that is | ||
877 | already defined in the Python script. The default value of the parameter | ||
878 | is displayed after this symbol.</para> | ||
879 | |||
880 | <para>To use or change the default value of one or more parameters, | ||
881 | perform one of the following methods:</para> | ||
882 | |||
883 | <itemizedlist> | ||
884 | <listitem> | ||
885 | <para>Run the Python API using only the values of the parameters | ||
886 | without specifying the parameters' names. All parameters will | ||
887 | be given and the value will be the position of each parameter.</para> | ||
888 | </listitem> | ||
889 | |||
890 | <listitem> | ||
891 | <para>Run the Python API using the | ||
892 | <literal><parameter_name>=</literal> syntax. Only specific | ||
893 | parameters will be given and they will be specified as | ||
894 | <literal><parameter_name>=<parameter_value></literal>.</para> | ||
895 | </listitem> | ||
896 | |||
897 | <listitem> | ||
898 | <para>Run the Python API with a mix of parameters. Mandatory | ||
899 | parameters will be given without specifying their name (their | ||
900 | position will be used in this situation) and the optional parameters | ||
901 | will be given, using the syntax:<literal> | ||
902 | <parameter_name>=<parameter_value></literal>.</para> | ||
903 | </listitem> | ||
904 | </itemizedlist> | ||
905 | |||
871 | <para>In the <literal>test_harness/<module name></literal> | 906 | <para>In the <literal>test_harness/<module name></literal> |
872 | directory, the Ansible Playbooks are implemented for running the Python | 907 | directory, the Ansible Playbooks are implemented for running the Python |
873 | scripts from Enea Edge Automation. The name of the Ansible Playbooks is | 908 | scripts from Enea Edge Automation. The name of the Ansible Playbooks is |