No information about essential attributes for neutron agent-update (Chapter 7. Networking command-line client in OpenStack Command-Line Interface Reference - current)

[George Shuklin]

There is no information in any documentation for openstack about enabling/disabling neutron agents.

After asking in openstack-operators, proper command is

neutron agent-update --admin-state-up=False AGENT"

Documentation for agent-update is really sparse and just says:

neutron agent-update
usage: neutron agent-update [-h] [--request-format {json,xml}] AGENT
Update a given agent.

And there is no information how to use this sommand or how to pass arguments.

I think:

1) Help should be changed to more accurate to reflect possible values (--important=option), or at least mention about syntax (--foo=bar)

2) There should be at least one example of all. I think noted example for enabling/disabling agents is nice.

-----------------------------------
Built: 2014-10-20T07:25:46 00:00
git SHA: 9dde80698bb41d471a79cc8cd9c71b3177f48e4a
URL: http://docs.openstack.org/cli-reference/content/neutronclient_commands.html
source File: file:/home/jenkins/workspace/openstack-manuals-tox-doc-publishdocs/doc/cli-reference/generated/ch_cli_neutron_commands.xml
xml:id: neutronclient_commands

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/156950

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/156950
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=d707bb7bf0bb27334174f8b272d7e77380dfc7f0
Submitter: Jenkins
Branch: master

commit d707bb7bf0bb27334174f8b272d7e77380dfc7f0
Author: Alexander Adamov <email address hidden>
Date: Wed Feb 18 13:20:04 2015 +0200

    [Cloud Admin Guide] Info on neutron agents operations

    Added information on management of neutron agents,
     such as disable/enable operations. The reference to
     OpenStack Command-Line Interface Reference is
     provided as well.

    Change-Id: I3d82b848ae17d33f2e39dee30cb2618cd6d4a67b
    Closes-Bug: #1383483

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.