From 9cd835db3dad5cb8e374b2c6b265201c71246318 Mon Sep 17 00:00:00 2001 From: garciadeblas Date: Tue, 4 Dec 2018 16:58:03 +0100 Subject: [PATCH] fix help message for osm vnf-list and nf-list Change-Id: I58232f98816e0e19c8aef8a35c475db725ea43a0 Signed-off-by: garciadeblas --- osmclient/scripts/osm.py | 95 ++++++++++++++++++++-------------------- 1 file changed, 48 insertions(+), 47 deletions(-) diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index bbc187d..0a1f7c3 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -319,53 +319,6 @@ def nfpkg_list(ctx, nf_type, filter): def vnf_list(ctx, ns, filter): - '''list all VNF instances - - \b - Options: - --ns TEXT NS instance id or name to restrict the VNF list - --filter filterExpr Restricts the list to the VNF instances matching the filter - - \b - filterExpr consists of one or more strings formatted according to "simpleFilterExpr", - concatenated using the "&" character: - - \b - filterExpr := ["&"]* - simpleFilterExpr := ["."]*["."]"="[","]* - op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont" - attrName := string - value := scalar value - - \b - where: - * zero or more occurrences - ? zero or one occurrence - [] grouping of expressions to be used with ? and * - "" quotation marks for marking string constants - <> name separator - - \b - "AttrName" is the name of one attribute in the data type that defines the representation - of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of - entries to filter by attributes deeper in the hierarchy of a structured document. - "Op" stands for the comparison operator. If the expression has concatenated - entries, it means that the operator "op" is applied to the attribute addressed by the last - entry included in the concatenation. All simple filter expressions are combined - by the "AND" logical operator. In a concatenation of entries in a , - the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The - concatenation of all "attrName" entries except the leaf attribute is called the "attribute - prefix". If an attribute referenced in an expression is an array, an object that contains a - corresponding array shall be considered to match the expression if any of the elements in the - array matches all expressions that have the same attribute prefix. - - \b - Filter examples: - --filter vim-account-id= - --filter vnfd-ref= - --filter vdur.ip-address= - --filter vnfd-ref=,vdur.ip-address= - ''' try: if ns or filter: if ns: @@ -423,6 +376,7 @@ def vnf_list(ctx, ns, filter): help='restricts the list to the NF instances matching the filter.') @click.pass_context def vnf_list1(ctx, ns, filter): + '''list all NF instances''' vnf_list(ctx, ns, filter) @@ -432,6 +386,53 @@ def vnf_list1(ctx, ns, filter): help='restricts the list to the NF instances matching the filter.') @click.pass_context def nf_list(ctx, ns, filter): + '''list all NF instances + + \b + Options: + --ns TEXT NS instance id or name to restrict the VNF list + --filter filterExpr Restricts the list to the VNF instances matching the filter + + \b + filterExpr consists of one or more strings formatted according to "simpleFilterExpr", + concatenated using the "&" character: + + \b + filterExpr := ["&"]* + simpleFilterExpr := ["."]*["."]"="[","]* + op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont" + attrName := string + value := scalar value + + \b + where: + * zero or more occurrences + ? zero or one occurrence + [] grouping of expressions to be used with ? and * + "" quotation marks for marking string constants + <> name separator + + \b + "AttrName" is the name of one attribute in the data type that defines the representation + of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of + entries to filter by attributes deeper in the hierarchy of a structured document. + "Op" stands for the comparison operator. If the expression has concatenated + entries, it means that the operator "op" is applied to the attribute addressed by the last + entry included in the concatenation. All simple filter expressions are combined + by the "AND" logical operator. In a concatenation of entries in a , + the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The + concatenation of all "attrName" entries except the leaf attribute is called the "attribute + prefix". If an attribute referenced in an expression is an array, an object that contains a + corresponding array shall be considered to match the expression if any of the elements in the + array matches all expressions that have the same attribute prefix. + + \b + Filter examples: + --filter vim-account-id= + --filter vnfd-ref= + --filter vdur.ip-address= + --filter vnfd-ref=,vdur.ip-address= + ''' vnf_list(ctx, ns, filter) -- 2.17.1