diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/compute-agent.rst | 100 | ||||
| -rw-r--r-- | doc/source/command-objects/compute-service.rst | 73 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 38 |
3 files changed, 207 insertions, 4 deletions
diff --git a/doc/source/command-objects/compute-agent.rst b/doc/source/command-objects/compute-agent.rst new file mode 100644 index 00000000..395ee4f3 --- /dev/null +++ b/doc/source/command-objects/compute-agent.rst @@ -0,0 +1,100 @@ +============= +compute agent +============= + +Compute v2 + +compute agent create +-------------------- + +Create compute agent + +.. program:: compute agent create +.. code:: bash + + os compute agent create + <os> <architecture> <version> <url> <md5hash> + <hypervisor> + +.. _compute_agent-create: +.. describe:: <os> + + Type of OS + +.. describe:: <architecture> + + Type of architecture + +.. describe:: <version> + + Version + +.. describe:: <url> + + URL + +.. describe:: <md5hash> + + MD5 hash + +.. describe:: <hypervisor> + + Type of hypervisor + +compute agent delete +-------------------- + +Delete compute agent command + +.. program:: compute agent delete +.. code:: bash + + os compute agent delete <id> + +.. _compute_agent-delete: +.. describe:: <id> + + ID of agent to delete + +compute agent list +------------------ + +List compute agent command + +.. program:: compute agent list +.. code:: bash + + os compute agent list [--hypervisor <hypervisor>] + +.. _compute_agent-list: +.. describe:: --hypervisor <hypervisor> + + Optional type of hypervisor + +compute agent set +----------------- + +Set compute agent command + +.. program:: agent set +.. code:: bash + + os compute agent set + <id> <version> <url> <md5hash> + +.. _compute_agent-set: +.. describe:: <id> + + ID of the agent + +.. describe:: <version> + + Version of the agent + +.. describe:: <url> + + URL + +.. describe:: <md5hash> + + MD5 hash diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst new file mode 100644 index 00000000..95a77bdf --- /dev/null +++ b/doc/source/command-objects/compute-service.rst @@ -0,0 +1,73 @@ +=============== +compute service +=============== + +Compute v2 + +compute service delete +---------------------- + +Delete service command + +.. program:: compute service delete +.. code:: bash + + os compute service delete + <service> + +.. _compute-service-delete: +.. describe:: <service> + + Compute service to delete (ID only) + +compute service list +-------------------- + +List service command + +.. program:: compute service list +.. code:: bash + + os compute service list + [--host <host>] + [--service <service>] + +.. _compute-service-list: +.. describe:: --host <host> + + Name of host + +.. describe:: --service <service> + + Name of service + + +compute service set +------------------- + +Set service command + +.. program:: compute service set +.. code:: bash + + os compute service list + [--enable | --disable] + <host> <service> + +.. _compute-service-set: +.. describe:: --enable + + Enable service + +.. describe:: --disable + + Disable service + +.. describe:: <host> + + Name of host + +.. describe:: <service> + + Name of service + diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 9ff48437..83f83ddc 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -165,7 +165,7 @@ Delete server(s) .. describe:: <server> - Server to delete (name or ID) + Server(s) to delete (name or ID) server list ----------- @@ -311,17 +311,17 @@ Migrate server to different host server pause ------------ -Pause server +Pause server(s) .. program:: server pause .. code:: bash os server pause - <server> + <server> [<server> ...] .. describe:: <server> - Server (name or ID) + Server(s) to pause (name or ID) server reboot ------------- @@ -595,6 +595,36 @@ Ssh to server Server (name or ID) +server start +------------ + +Start server(s) + +.. program:: server start +.. code:: bash + + os server start + <server> [<server> ...] + +.. describe:: <server> + + Server(s) to start (name or ID) + +server stop +----------- + +Stop server(s) + +.. program:: server stop +.. code:: bash + + os server stop + <server> [<server> ...] + +.. describe:: <server> + + Server(s) to stop (name or ID) + server suspend -------------- |