[Bug 1589432] Re: neutron cli puts the required parameters into option arguments group

[Andreas Jaeger]

Run "neutron help bgp-peer-create", you'll get the following output:

usage: neutron bgp-peer-create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               [--request-format {json}]
                               [--tenant-id TENANT_ID] --peer-ip
                               PEER_IP_ADDRESS --remote-as PEER_REMOTE_AS
                               [--auth-type PEER_AUTH_TYPE]
                               [--password AUTH_PASSWORD]
                               NAME

Create a BGP Peer.

positional arguments:
  NAME                  Name of the BGP peer to create.

optional arguments:
  -h, --help            show this help message and exit
  --request-format {json}
                        DEPRECATED! Only JSON request format is supported.
  --tenant-id TENANT_ID
                        The owner tenant ID.
  --peer-ip PEER_IP_ADDRESS
                        Peer IP address.
  --remote-as PEER_REMOTE_AS
                        Peer AS number. (Integer in [1, 65535] is allowed.)
  --auth-type PEER_AUTH_TYPE
                        Authentication algorithm. Supported algorithms:
                        none(default), md5
  --password AUTH_PASSWORD
                        Authentication password.

output formatters:
  output formatter options

  -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}
                        the output format, defaults to table
  -c COLUMN, --column COLUMN
                        specify the column(s) to include, can be repeated

table formatter:
  --max-width <integer>
                        Maximum display width, 0 to disable

json formatter:
  --noindent            whether to disable indenting the JSON

shell formatter:
  a format a UNIX shell can parse (variable="value")

  --prefix PREFIX       add a prefix to all variable names

So, not a documentation bug.


** Changed in: openstack-manuals
       Status: Confirmed => Invalid

-- 
You received this bug notification because you are a member of Ubuntu
OpenStack, which is subscribed to python-neutronclient in Ubuntu.
https://bugs.launchpad.net/bugs/1589432

Title:
  neutron cli puts the required parameters into option arguments group

Status in openstack-manuals:
  Invalid
Status in python-neutronclient package in Ubuntu:
  Triaged

Bug description:
  In neutron cli, there are many scenario like below, some parameters
  such as --peer-ip and --remote-as are defined as required ones, but
  they are put into optional arguments group. That is wrong.

  usage: neutron bgp-peer-create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [--request-format {json}]
                                 [--tenant-id TENANT_ID] --peer-ip
                                 PEER_IP_ADDRESS --remote-as PEER_REMOTE_AS
                                 [--auth-type PEER_AUTH_TYPE]
                                 [--password AUTH_PASSWORD]
                                 NAME

  Create a BGP Peer.

  positional arguments:
    NAME                  Name of the BGP peer to create.

  optional arguments:
    -h, --help            show this help message and exit
    --request-format {json}
                          DEPRECATED! Only JSON request format is supported.
    --tenant-id TENANT_ID
                          The owner tenant ID.
    --peer-ip PEER_IP_ADDRESS
                          Peer IP address.
    --remote-as PEER_REMOTE_AS
                          Peer AS number. (Integer in [1, 65535] is allowed.)
    --auth-type PEER_AUTH_TYPE
                          Authentication algorithm. Supported algorithms:
                          none(default), md5
    --password AUTH_PASSWORD
                          Authentication password.

To manage notifications about this bug go to:
https://bugs.launchpad.net/openstack-manuals/+bug/1589432/+subscriptions