77833edb80
Change-Id: I96ea2a8a493b823518c0a16219303f8a5bcc03c3 Related-Bug: #1488505
1344 lines
39 KiB
XML
1344 lines
39 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="magnumclient_commands">
|
|
|
|
<!-- This file is automatically generated, do not edit -->
|
|
|
|
<?dbhtml stop-chunking?>
|
|
|
|
<title>Containers service command-line client</title>
|
|
|
|
<para>The <command>magnum</command> client is the command-line
|
|
interface (CLI) for the Containers service API and its extensions.
|
|
|
|
This chapter documents <command>magnum</command> version
|
|
<literal>0.2.1</literal>.
|
|
</para>
|
|
|
|
<para>For help on a specific <command>magnum</command>
|
|
command, enter:
|
|
</para>
|
|
<screen><prompt>$</prompt> <userinput><command>magnum</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
|
|
<section xml:id="magnumclient_command_usage">
|
|
<title>magnum usage</title>
|
|
<screen><computeroutput>usage: magnum [--version] [--debug] [--os-cache]
|
|
[--os-region-name <region-name>]
|
|
[--os-tenant-id <auth-tenant-id>]
|
|
[--service-type <service-type>]
|
|
[--endpoint-type <endpoint-type>]
|
|
[--magnum-api-version <magnum-api-ver>]
|
|
[--os-cacert <ca-certificate>] [--bypass-url <bypass-url>]
|
|
[--os-auth-system <auth-system>] [--os-username <username>]
|
|
[--os-password <password>] [--os-tenant-name <tenant-name>]
|
|
[--os-token <token>] [--os-auth-url <auth-url>]
|
|
<subcommand> ...</computeroutput></screen>
|
|
<variablelist wordsize="10">
|
|
<title>Subcommands</title>
|
|
<varlistentry>
|
|
<term><command>bay-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>bay-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete specified bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>bay-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of available bays.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>bay-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about the given bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>bay-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update information about the given bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baymodel-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a baymodel.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baymodel-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete specified baymodel.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baymodel-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of bay models.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baymodel-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about the given baymodel.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a container.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete specified containers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-execute</command></term>
|
|
<listitem>
|
|
<para>
|
|
Execute command in a container.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of available containers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-logs</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get logs of a container.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-pause</command></term>
|
|
<listitem>
|
|
<para>
|
|
Pause specified containers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-reboot</command></term>
|
|
<listitem>
|
|
<para>
|
|
Reboot specified containers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details of a container.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-start</command></term>
|
|
<listitem>
|
|
<para>
|
|
Start specified containers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-stop</command></term>
|
|
<listitem>
|
|
<para>
|
|
Stop specified containers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>container-unpause</command></term>
|
|
<listitem>
|
|
<para>
|
|
Unpause specified containers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>node-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>node-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of configured nodes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>pod-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a pod.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>pod-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete specified pod.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>pod-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of registered pods.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>pod-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about the given pod.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>pod-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update information about the given pod.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rc-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a replication controller.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rc-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete specified replication controller.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rc-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of registered replication controllers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rc-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about the given replication controller.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rc-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update information about the given replication
|
|
controller.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete specified service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of services.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about the given service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update information about the given service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>bash-completion</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prints arguments for bash-completion. Prints all of
|
|
the commands and options to stdout so that the
|
|
magnum.bash_completion script doesn't have to hard
|
|
code them.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>help</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display help about this program or one of its
|
|
subcommands.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_command_optional">
|
|
<title>magnum optional arguments</title>
|
|
<variablelist wordsize="10">
|
|
<varlistentry>
|
|
<term><command>--version</command></term>
|
|
<listitem>
|
|
<para>
|
|
show program's version number and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--debug</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print debugging output.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cache</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use the auth token cache. Defaults to False if
|
|
<code>env[OS_CACHE]</code> is not set.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-region-name <region-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Region name. Default=<code>env[OS_REGION_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-id <auth-tenant-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TENANT_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service-type <service-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to container for all actions.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--endpoint-type <endpoint-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[MAGNUM_ENDPOINT_TYPE]</code> or publicURL.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--magnum-api-version <magnum-api-ver></command></term>
|
|
<listitem>
|
|
<para>
|
|
Accepts "api", defaults to <code>env[MAGNUM_API_VERSION]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cacert <ca-certificate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify a CA bundle file to use in verifying a TLS
|
|
(https) server certificate. Defaults to
|
|
<code>env[OS_CACERT]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--bypass-url <bypass-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Use this API endpoint instead of the Service Catalog.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_command_common_auth">
|
|
<title>magnum common authentication arguments</title>
|
|
<variablelist wordsize="10">
|
|
<varlistentry>
|
|
<term><command>--os-auth-system <auth-system></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_SYSTEM]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-username <username></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USERNAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-password <password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PASSWORD]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-name <tenant-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TENANT_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-token <token></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TOKEN]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-url <auth-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_URL]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_bay-create">
|
|
<title>magnum bay-create</title>
|
|
<screen><computeroutput>usage: magnum bay-create [--name <name>] --baymodel <baymodel>
|
|
[--node-count <node-count>]
|
|
[--discovery-url <discovery-url>]
|
|
[--timeout <timeout>]</computeroutput></screen>
|
|
<para>
|
|
Create a bay.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the bay to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--baymodel <baymodel></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the baymodel.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--node-count <node-count></command></term>
|
|
<listitem>
|
|
<para>
|
|
The bay node count.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--discovery-url <discovery-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies custom discovery url for node discovery.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--timeout <timeout></command></term>
|
|
<listitem>
|
|
<para>
|
|
The timeout for bay creation in minutes. Set to 0 for
|
|
no timeout. The default is no timeout.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_bay-delete">
|
|
<title>magnum bay-delete</title>
|
|
<screen><computeroutput>usage: magnum bay-delete <bay> [<bay> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete specified bay.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><bay></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the (bay)s to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_bay-list">
|
|
<title>magnum bay-list</title>
|
|
<screen><computeroutput>usage: magnum bay-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of available bays.
|
|
</para>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_bay-show">
|
|
<title>magnum bay-show</title>
|
|
<screen><computeroutput>usage: magnum bay-show <bay></computeroutput></screen>
|
|
<para>
|
|
Show details about the given bay.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><bay></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the bay to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_bay-update">
|
|
<title>magnum bay-update</title>
|
|
<screen><computeroutput>usage: magnum bay-update <bay> <op> <path=value> [<path=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Update information about the given bay.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><bay></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID or name of bay
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><op></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operations: 'add', 'replace' or 'remove'
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><path=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Attributes to add/replace or remove (only PATH is necessary on
|
|
remove)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_baymodel-create">
|
|
<title>magnum baymodel-create</title>
|
|
<screen><computeroutput>usage: magnum baymodel-create [--name <name>] --image-id <image-id>
|
|
--keypair-id <keypair-id> --external-network-id
|
|
<external-network-id> --coe <coe>
|
|
[--fixed-network <fixed-network>]
|
|
[--ssh-authorized-key <ssh-authorized-key>]
|
|
[--dns-nameserver <dns-nameserver>]
|
|
[--flavor-id <flavor-id>]
|
|
[--master-flavor-id <master-flavor-id>]
|
|
[--docker-volume-size <docker-volume-size>]</computeroutput></screen>
|
|
<para>
|
|
Create a baymodel.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the bay to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image-id <image-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
The name or UUID of the base image to customize for
|
|
the bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--keypair-id <keypair-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
The name or UUID of the SSH keypair to load into the
|
|
Bay nodes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--external-network-id <external-network-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
The external Neutron network ID to connect to this bay
|
|
model.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--coe <coe></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the Container Orchestration Engine to use.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-network <fixed-network></command></term>
|
|
<listitem>
|
|
<para>
|
|
The private Neutron network name to connect to this
|
|
bay model.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ssh-authorized-key <ssh-authorized-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
The SSH authorized key to use
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dns-nameserver <dns-nameserver></command></term>
|
|
<listitem>
|
|
<para>
|
|
The DNS nameserver to use for this Bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--flavor-id <flavor-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
The nova flavor id to use when launching the bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--master-flavor-id <master-flavor-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
The nova flavor id to use when launching the master
|
|
nodeof the bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--docker-volume-size <docker-volume-size></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the size of the docker volume to use.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_baymodel-delete">
|
|
<title>magnum baymodel-delete</title>
|
|
<screen><computeroutput>usage: magnum baymodel-delete <baymodels> [<baymodels> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete specified baymodel.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><baymodels></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the (baymodel)s to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_baymodel-list">
|
|
<title>magnum baymodel-list</title>
|
|
<screen><computeroutput>usage: magnum baymodel-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of bay models.
|
|
</para>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_baymodel-show">
|
|
<title>magnum baymodel-show</title>
|
|
<screen><computeroutput>usage: magnum baymodel-show <baymodel></computeroutput></screen>
|
|
<para>
|
|
Show details about the given baymodel.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><baymodel></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the baymodel to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-create">
|
|
<title>magnum container-create</title>
|
|
<screen><computeroutput>usage: magnum container-create [--json JSON]</computeroutput></screen>
|
|
<para>
|
|
Create a container.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--json JSON</command></term>
|
|
<listitem>
|
|
<para>
|
|
JSON representation of container.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-delete">
|
|
<title>magnum container-delete</title>
|
|
<screen><computeroutput>usage: magnum container-delete <container> [<container> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete specified containers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the (container)s to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-execute">
|
|
<title>magnum container-execute</title>
|
|
<screen><computeroutput>usage: magnum container-execute --command <command> <container></computeroutput></screen>
|
|
<para>
|
|
Execute command in a container.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the container to start.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--command <command></command></term>
|
|
<listitem>
|
|
<para>
|
|
The command to execute
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-list">
|
|
<title>magnum container-list</title>
|
|
<screen><computeroutput>usage: magnum container-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of available containers.
|
|
</para>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-logs">
|
|
<title>magnum container-logs</title>
|
|
<screen><computeroutput>usage: magnum container-logs <container></computeroutput></screen>
|
|
<para>
|
|
Get logs of a container.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the container to start.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-pause">
|
|
<title>magnum container-pause</title>
|
|
<screen><computeroutput>usage: magnum container-pause <container> [<container> ...]</computeroutput></screen>
|
|
<para>
|
|
Pause specified containers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the (container)s to start.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-reboot">
|
|
<title>magnum container-reboot</title>
|
|
<screen><computeroutput>usage: magnum container-reboot <container> [<container> ...]</computeroutput></screen>
|
|
<para>
|
|
Reboot specified containers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the (container)s to start.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-show">
|
|
<title>magnum container-show</title>
|
|
<screen><computeroutput>usage: magnum container-show [--json] <container></computeroutput></screen>
|
|
<para>
|
|
Show details of a container.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the container to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--json</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print JSON representation of the container.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-start">
|
|
<title>magnum container-start</title>
|
|
<screen><computeroutput>usage: magnum container-start <container> [<container> ...]</computeroutput></screen>
|
|
<para>
|
|
Start specified containers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the (container)s to start.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-stop">
|
|
<title>magnum container-stop</title>
|
|
<screen><computeroutput>usage: magnum container-stop <container> [<container> ...]</computeroutput></screen>
|
|
<para>
|
|
Stop specified containers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the (container)s to start.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_container-unpause">
|
|
<title>magnum container-unpause</title>
|
|
<screen><computeroutput>usage: magnum container-unpause <container> [<container> ...]</computeroutput></screen>
|
|
<para>
|
|
Unpause specified containers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the (container)s to start.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_node-create">
|
|
<title>magnum node-create</title>
|
|
<screen><computeroutput>usage: magnum node-create [--type <type>] [--image-id <image-id>]</computeroutput></screen>
|
|
<para>
|
|
Create a node.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--type <type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of node to create (virt or bare).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image-id <image-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
The name or UUID of the base image to use for the
|
|
node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_node-list">
|
|
<title>magnum node-list</title>
|
|
<screen><computeroutput>usage: magnum node-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of configured nodes.
|
|
</para>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_pod-create">
|
|
<title>magnum pod-create</title>
|
|
<screen><computeroutput>usage: magnum pod-create [--manifest-url <manifest-url>]
|
|
[--manifest <manifest>] --bay <bay></computeroutput></screen>
|
|
<para>
|
|
Create a pod.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--manifest-url <manifest-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name/URL of the pod file to use for creating PODs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--manifest <manifest></command></term>
|
|
<listitem>
|
|
<para>
|
|
File path of the pod file to use for creating PODs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--bay <bay></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_pod-delete">
|
|
<title>magnum pod-delete</title>
|
|
<screen><computeroutput>usage: magnum pod-delete <pods> [<pods> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete specified pod.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><pods></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the (pod)s to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_pod-list">
|
|
<title>magnum pod-list</title>
|
|
<screen><computeroutput>usage: magnum pod-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of registered pods.
|
|
</para>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_pod-show">
|
|
<title>magnum pod-show</title>
|
|
<screen><computeroutput>usage: magnum pod-show <pod></computeroutput></screen>
|
|
<para>
|
|
Show details about the given pod.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><pod></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the pod to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_pod-update">
|
|
<title>magnum pod-update</title>
|
|
<screen><computeroutput>usage: magnum pod-update <pod-id> <op> <path=value> [<path=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Update information about the given pod.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><pod-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID or name of pod
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><op></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operations: 'add', 'replace' or 'remove'
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><path=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Attributes to add/replace or remove (only PATH is necessary on
|
|
remove)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_rc-create">
|
|
<title>magnum rc-create</title>
|
|
<screen><computeroutput>usage: magnum rc-create [--manifest-url <manifest-url>]
|
|
[--manifest <manifest>] --bay <bay></computeroutput></screen>
|
|
<para>
|
|
Create a replication controller.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--manifest-url <manifest-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name/URL of the replication controller file to use for
|
|
creating replication controllers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--manifest <manifest></command></term>
|
|
<listitem>
|
|
<para>
|
|
File path of the replication controller file to use
|
|
for creating replication controllers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--bay <bay></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_rc-delete">
|
|
<title>magnum rc-delete</title>
|
|
<screen><computeroutput>usage: magnum rc-delete <rcs> [<rcs> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete specified replication controller.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><rcs></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the replication (controller)s to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_rc-list">
|
|
<title>magnum rc-list</title>
|
|
<screen><computeroutput>usage: magnum rc-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of registered replication controllers.
|
|
</para>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_rc-show">
|
|
<title>magnum rc-show</title>
|
|
<screen><computeroutput>usage: magnum rc-show <rc></computeroutput></screen>
|
|
<para>
|
|
Show details about the given replication controller.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><rc></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the replication controller to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_rc-update">
|
|
<title>magnum rc-update</title>
|
|
<screen><computeroutput>usage: magnum rc-update <rc> <op> <path=value> [<path=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Update information about the given replication controller.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><rc></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID or name of replication controller
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><op></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operations: 'add', 'replace' or 'remove'
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><path=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Attributes to add/replace or remove (only PATH is necessary on
|
|
remove)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_service-create">
|
|
<title>magnum service-create</title>
|
|
<screen><computeroutput>usage: magnum service-create [--manifest-url <manifest-url>]
|
|
[--manifest <manifest>] --bay <bay></computeroutput></screen>
|
|
<para>
|
|
Create a service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--manifest-url <manifest-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name/URL of the serivce file to use for creating
|
|
services.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--manifest <manifest></command></term>
|
|
<listitem>
|
|
<para>
|
|
File path of the service file to use for creating
|
|
services.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--bay <bay></command></term>
|
|
<listitem>
|
|
<para>
|
|
Id or name of the bay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_service-delete">
|
|
<title>magnum service-delete</title>
|
|
<screen><computeroutput>usage: magnum service-delete <services> [<services> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete specified service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><services></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the (service)s to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_service-list">
|
|
<title>magnum service-list</title>
|
|
<screen><computeroutput>usage: magnum service-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of services.
|
|
</para>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_service-show">
|
|
<title>magnum service-show</title>
|
|
<screen><computeroutput>usage: magnum service-show <service></computeroutput></screen>
|
|
<para>
|
|
Show details about the given service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the service to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="magnumclient_subcommand_service-update">
|
|
<title>magnum service-update</title>
|
|
<screen><computeroutput>usage: magnum service-update <service> <op> <path=value> [<path=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Update information about the given service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID or name of service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><op></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operations: 'add', 'replace' or 'remove'
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><path=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Attributes to add/replace or remove (only PATH is necessary on
|
|
remove)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</chapter>
|