← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1582623] [NEW] there is no description about required argument pool_id in ' lbaas-healthmonitor-create -h'

 

Public bug reported:

It is in kilo branch.

Should we add the description of pool_id in the help information of this
command? It will be more convenient for users.

1. From following help information,it doesn't have the description of required attribute 'pool_id'.
[root@opencos2 ~(keystone_admin)]# neutron lbaas-healthmonitor-create -h
usage: neutron lbaas-healthmonitor-create [-h] [-f {shell,table,value}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--prefix PREFIX]
                                          [--request-format {json,xml}]
                                          [--tenant-id TENANT_ID]
                                          [--admin-state-down]
                                          [--expected-codes EXPECTED_CODES]
                                          [--http-method HTTP_METHOD]
                                          [--url-path URL_PATH] --delay DELAY
                                          --max-retries MAX_RETRIES --timeout
                                          TIMEOUT --type {PING,TCP,HTTP,HTTPS}

LBaaS v2 Create a healthmonitor.

optional arguments:
  -h, --help            show this help message and exit
  --request-format {json,xml}
                        The XML or JSON request format.
  --tenant-id TENANT_ID
                        The owner tenant ID.
  --admin-state-down    Set admin state up to false.
  --expected-codes EXPECTED_CODES
                        The list of HTTP status codes expected in response
                        from the member to declare it healthy. This attribute
                        can contain one value, or a list of values separated
                        by comma, or a range of values (e.g. "200-299"). If
                        this attribute is not specified, it defaults to "200".
  --http-method HTTP_METHOD
                        The HTTP method used for requests by the monitor of
                        type HTTP.
  --url-path URL_PATH   The HTTP path used in the HTTP request used by the
                        monitor to test a member health. This must be a string
                        beginning with a / (forward slash).
  --delay DELAY         The time in seconds between sending probes to members.
  --max-retries MAX_RETRIES
                        Number of permissible connection failures before
                        changing the member status to INACTIVE. [1..10].
  --timeout TIMEOUT     Maximum number of seconds for a monitor to wait for a
                        connection to be established before it times out. The
                        value must be less than the delay value.
  --type {PING,TCP,HTTP,HTTPS}
                        One of the predefined health monitor types.

output formatters:
  output formatter options

  -f {shell,table,value}, --format {shell,table,value}
                        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

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

  --prefix PREFIX       add a prefix to all variable names

2. If I don't input the pool_id, it fails to create.

[root@opencos2 ~(keystone_admin)]# neutron lbaas-healthmonitor-create --delay 1 --max-retries 2 --timeout 3  --type PING
Failed to parse request. Required attribute 'pool_id' not specified

3. After adding --pool_id, it creates successfully.
[root@opencos2 ~(keystone_admin)]# neutron lbaas-healthmonitor-create --delay 1 --max-retries 2 --timeout 3  --type PING --pool_id f0ee8335-a63d-4aac-be30-fe6651c95f78
Created a new healthmonitor:
+----------------+------------------------------------------------+
| Field          | Value                                          |
+----------------+------------------------------------------------+
| admin_state_up | True                                           |
| delay          | 1                                              |
| expected_codes | 200                                            |
| http_method    | GET                                            |
| id             | 3135423b-beba-41fc-b607-1307b1fe65df           |
| max_retries    | 2                                              |
| pools          | {"id": "f0ee8335-a63d-4aac-be30-fe6651c95f78"} |
| tenant_id      | be58eaec789d44f296a65f96b944a9f5               |
| timeout        | 3                                              |
| type           | PING                                           |
| url_path       | /                                              |
+----------------+------------------------------------------------+

** Affects: neutron
     Importance: Undecided
         Status: New


** Tags: lbaas

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to neutron.
https://bugs.launchpad.net/bugs/1582623

Title:
  there is no description about required argument pool_id  in ' lbaas-
  healthmonitor-create -h'

Status in neutron:
  New

Bug description:
  It is in kilo branch.

  Should we add the description of pool_id in the help information of
  this command? It will be more convenient for users.

  1. From following help information,it doesn't have the description of required attribute 'pool_id'.
  [root@opencos2 ~(keystone_admin)]# neutron lbaas-healthmonitor-create -h
  usage: neutron lbaas-healthmonitor-create [-h] [-f {shell,table,value}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--prefix PREFIX]
                                            [--request-format {json,xml}]
                                            [--tenant-id TENANT_ID]
                                            [--admin-state-down]
                                            [--expected-codes EXPECTED_CODES]
                                            [--http-method HTTP_METHOD]
                                            [--url-path URL_PATH] --delay DELAY
                                            --max-retries MAX_RETRIES --timeout
                                            TIMEOUT --type {PING,TCP,HTTP,HTTPS}

  LBaaS v2 Create a healthmonitor.

  optional arguments:
    -h, --help            show this help message and exit
    --request-format {json,xml}
                          The XML or JSON request format.
    --tenant-id TENANT_ID
                          The owner tenant ID.
    --admin-state-down    Set admin state up to false.
    --expected-codes EXPECTED_CODES
                          The list of HTTP status codes expected in response
                          from the member to declare it healthy. This attribute
                          can contain one value, or a list of values separated
                          by comma, or a range of values (e.g. "200-299"). If
                          this attribute is not specified, it defaults to "200".
    --http-method HTTP_METHOD
                          The HTTP method used for requests by the monitor of
                          type HTTP.
    --url-path URL_PATH   The HTTP path used in the HTTP request used by the
                          monitor to test a member health. This must be a string
                          beginning with a / (forward slash).
    --delay DELAY         The time in seconds between sending probes to members.
    --max-retries MAX_RETRIES
                          Number of permissible connection failures before
                          changing the member status to INACTIVE. [1..10].
    --timeout TIMEOUT     Maximum number of seconds for a monitor to wait for a
                          connection to be established before it times out. The
                          value must be less than the delay value.
    --type {PING,TCP,HTTP,HTTPS}
                          One of the predefined health monitor types.

  output formatters:
    output formatter options

    -f {shell,table,value}, --format {shell,table,value}
                          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

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

    --prefix PREFIX       add a prefix to all variable names

  2. If I don't input the pool_id, it fails to create.

  [root@opencos2 ~(keystone_admin)]# neutron lbaas-healthmonitor-create --delay 1 --max-retries 2 --timeout 3  --type PING
  Failed to parse request. Required attribute 'pool_id' not specified

  3. After adding --pool_id, it creates successfully.
  [root@opencos2 ~(keystone_admin)]# neutron lbaas-healthmonitor-create --delay 1 --max-retries 2 --timeout 3  --type PING --pool_id f0ee8335-a63d-4aac-be30-fe6651c95f78
  Created a new healthmonitor:
  +----------------+------------------------------------------------+
  | Field          | Value                                          |
  +----------------+------------------------------------------------+
  | admin_state_up | True                                           |
  | delay          | 1                                              |
  | expected_codes | 200                                            |
  | http_method    | GET                                            |
  | id             | 3135423b-beba-41fc-b607-1307b1fe65df           |
  | max_retries    | 2                                              |
  | pools          | {"id": "f0ee8335-a63d-4aac-be30-fe6651c95f78"} |
  | tenant_id      | be58eaec789d44f296a65f96b944a9f5               |
  | timeout        | 3                                              |
  | type           | PING                                           |
  | url_path       | /                                              |
  +----------------+------------------------------------------------+

To manage notifications about this bug go to:
https://bugs.launchpad.net/neutron/+bug/1582623/+subscriptions


Follow ups