How to specify complex input parameters or properties in command line options about zhmccli HOT 5 CLOSED

Have you tried to use string concatenation in option 1?

--ssc-network-info '[{"port": 444, "ipaddr-type": "static", "vlan-id": '$vlan_id', "static-ip-info": {"type": "ipv4", "ip-address": "'$ip_address'"}}]'

You need to put the shell variables in single quotation marks (basically end and start the string again). But at least bash typically concatenates everything and passes it as a single string to the program

from zhmccli.

Another observation: Option 2 looks very similar to the single line syntax of YAML. The most obvious difference is that you need commas between fields of an object and use : instead of =

from zhmccli.

Option 3: Single line YAML (aka "Flow Style")

The YAML spec calls this Flow Collection Styles.

Some sources claim that quotes around property names and string values would be needed, but that does not seem to be the case. Example: https://yaml-online-parser.appspot.com/?yaml=prop%3A+%7Bresult%3A+42%2C+name%3A+alice%7D%0A&type=json
Also the YAML spec confirms that no quotes are needed, see Example 7.15: https://yaml.org/spec/1.2.2/#rule-ns-s-flow-map-entries

Note that the flow collection style YAML is a superset of JSON, so double quotes around property names and string values can also be used.

Example for "ssc-network-info":

--ssc-network-info "[{port: 444, ipaddr-type: static, vlan-id: 53, static-ip-info: {type: ipv4, ip-address: '10.11.12.13'}}]"

Example for "ssc-network-info" when using shell/env variables:

--ssc-network-info "[{port: 444, ipaddr-type: static, vlan-id: $vlan_id, static-ip-info: {type: ipv4, ip-address: '$ip_address'}}]"

Examples with a (fantasy) escaped string value:

--properties '{description: ab\ncd}'
--properties "{description: ab\\ncd}"

I must say, I like option 3 the best.

We probably need to write a help topic with a short explanation of the syntax, since the YAML spec is hard to read for occasional users.

More understandable descriptions of flow style that we could refrence:

• https://www.yaml.info/learn/flowstyle.html

Probably not so good:

• https://www.tutorialspoint.com/yaml/yaml_flow_styles.htm - shows the optional !!xxx YAML qualifiers
• https://tutorialreference.com/yaml/styles/yaml-flow-style - shows the optional !!xxx YAML qualifiers
• https://dev.to/this-is-learning/yaml-collections-sequences-and-mappings-4meb - not only about flow style

from zhmccli.

I have implemented option 3 in PR #537 - if we agree on that PR, I consider the decision made for using option 3.

from zhmccli.

We agreed on PR #537, so we will continue using option 3 in the future.
This issue is now complete.

from zhmccli.