12001 lines
351 KiB
XML
12001 lines
351 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="neutronclient_commands">
|
|
|
|
<!-- This file is automatically generated, do not edit -->
|
|
|
|
<?dbhtml stop-chunking?>
|
|
|
|
<title>Networking command-line client</title>
|
|
|
|
<para>The <command>neutron</command> client is the command-line
|
|
interface (CLI) for the OpenStack Networking API and its extensions.
|
|
|
|
This chapter documents <command>neutron</command> version
|
|
<literal>2.3.9</literal>.
|
|
</para>
|
|
|
|
<para>For help on a specific <command>neutron</command>
|
|
command, enter:
|
|
</para>
|
|
<screen><prompt>$</prompt> <userinput><command>neutron</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
|
|
<section xml:id="neutronclient_command_usage">
|
|
<title>neutron usage</title>
|
|
<screen><computeroutput>usage: neutron [--version] [-v] [-q] [-h] [-r NUM]
|
|
[--os-service-type <os-service-type>]
|
|
[--os-endpoint-type <os-endpoint-type>]
|
|
[--service-type <service-type>]
|
|
[--endpoint-type <endpoint-type>]
|
|
[--os-auth-strategy <auth-strategy>] [--os-auth-url <auth-url>]
|
|
[--os-tenant-name <auth-tenant-name> | --os-project-name <auth-project-name>]
|
|
[--os-tenant-id <auth-tenant-id> | --os-project-id <auth-project-id>]
|
|
[--os-username <auth-username>] [--os-user-id <auth-user-id>]
|
|
[--os-user-domain-id <auth-user-domain-id>]
|
|
[--os-user-domain-name <auth-user-domain-name>]
|
|
[--os-project-domain-id <auth-project-domain-id>]
|
|
[--os-project-domain-name <auth-project-domain-name>]
|
|
[--os-cert <certificate>] [--os-cacert <ca-certificate>]
|
|
[--os-key <key>] [--os-password <auth-password>]
|
|
[--os-region-name <auth-region-name>] [--os-token <token>]
|
|
[--http-timeout <seconds>] [--os-url <url>] [--insecure]</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="neutronclient_command_optional">
|
|
<title>neutron 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>-v, --verbose, --debug</command></term>
|
|
<listitem>
|
|
<para>
|
|
Increase verbosity of output and show tracebacks on
|
|
errors. You can repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-q, --quiet</command></term>
|
|
<listitem>
|
|
<para>
|
|
Suppress output except warnings and errors.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show this help message and exit.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-r NUM, --retries NUM</command></term>
|
|
<listitem>
|
|
<para>
|
|
How many times the request to the Neutron server
|
|
should be retried if it fails.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-service-type <os-service-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_NETWORK_SERVICE_TYPE]</code> or network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-endpoint-type <os-endpoint-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_ENDPOINT_TYPE]</code> or publicURL.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service-type <service-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use --os-service-type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--endpoint-type <endpoint-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use --os-endpoint-type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-strategy <auth-strategy></command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Only keystone is supported.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-url <auth-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication URL, defaults to <code>env[OS_AUTH_URL]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-name <auth-tenant-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication tenant name, defaults to
|
|
<code>env[OS_TENANT_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-name <auth-project-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Another way to specify tenant name. This option is
|
|
mutually exclusive with --os-tenant-name. Defaults to
|
|
<code>env[OS_PROJECT_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-id <auth-tenant-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication tenant ID, defaults to
|
|
<code>env[OS_TENANT_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-id <auth-project-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Another way to specify tenant ID. This option is
|
|
mutually exclusive with --os-tenant-id. Defaults to
|
|
<code>env[OS_PROJECT_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-username <auth-username></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication username, defaults to <code>env[OS_USERNAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-id <auth-user-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication user ID (Env: OS_USER_ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-id <auth-user-domain-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
OpenStack user domain ID. Defaults to
|
|
<code>env[OS_USER_DOMAIN_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-name <auth-user-domain-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
OpenStack user domain name. Defaults to
|
|
<code>env[OS_USER_DOMAIN_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-domain-id <auth-project-domain-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PROJECT_DOMAIN_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-domain-name <auth-project-domain-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PROJECT_DOMAIN_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cert <certificate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Path of certificate file to use in SSL connection.
|
|
This file can optionally be prepended with the private
|
|
key. Defaults to <code>env[OS_CERT]</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>--os-key <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Path of client key to use in SSL connection. This
|
|
option is not necessary if your key is prepended to
|
|
your certificate file. Defaults to <code>env[OS_KEY]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-password <auth-password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication password, defaults to <code>env[OS_PASSWORD]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-region-name <auth-region-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication region name, defaults to
|
|
<code>env[OS_REGION_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-token <token></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication token, defaults to <code>env[OS_TOKEN]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--http-timeout <seconds></command></term>
|
|
<listitem>
|
|
<para>
|
|
Timeout in seconds to wait for an HTTP response.
|
|
Defaults to <code>env[OS_NETWORK_TIMEOUT]</code> or None if not
|
|
specified.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-url <url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_URL]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--insecure</command></term>
|
|
<listitem>
|
|
<para>
|
|
Explicitly allow neutronclient to perform "insecure"
|
|
SSL (https) requests. The server's certificate will
|
|
not be verified against any certificate authorities.
|
|
This option should be used with caution.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_command_api_2_0">
|
|
<title>neutron API v2.0 commands</title>
|
|
<variablelist wordsize="10">
|
|
<varlistentry>
|
|
<term><command>agent-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>agent-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List agents.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>agent-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>agent-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-credential-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates a credential.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-credential-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given credential.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-credential-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List credentials that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-credential-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given credential.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-network-profile-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Creates a network profile.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-network-profile-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given network profile.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-network-profile-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List network profiles that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-network-profile-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given network profile.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-network-profile-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update network profile's information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-policy-profile-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List policy profiles that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-policy-profile-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given policy profile.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cisco-policy-profile-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update policy profile's information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>complete</command></term>
|
|
<listitem>
|
|
<para>
|
|
print bash completion command
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>dhcp-agent-list-hosting-net</command></term>
|
|
<listitem>
|
|
<para>
|
|
List DHCP agents hosting a network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>dhcp-agent-network-add</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add a network to a DHCP agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>dhcp-agent-network-remove</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a network from a DHCP agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>ext-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all extensions.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>ext-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given resource.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a firewall.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given firewall.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List firewalls that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-policy-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a firewall policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-policy-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given firewall policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-policy-insert-rule</command></term>
|
|
<listitem>
|
|
<para>
|
|
Insert a rule into a given firewall policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-policy-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List firewall policies that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-policy-remove-rule</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a rule from a given firewall policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-policy-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given firewall policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-policy-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given firewall policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-rule-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a firewall rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-rule-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given firewall rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-rule-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List firewall rules that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-rule-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given firewall rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-rule-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given firewall rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given firewall.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>firewall-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given firewall.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floatingip-associate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a mapping between a floating IP and a fixed IP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floatingip-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a floating IP for a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floatingip-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given floating IP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floatingip-disassociate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a mapping from a floating IP to a fixed IP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floatingip-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List floating IPs that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floatingip-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given floating IP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>gateway-device-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a network gateway device.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>gateway-device-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given network gateway device.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>gateway-device-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List network gateway devices for a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>gateway-device-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information for a given network gateway device.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>gateway-device-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a network gateway device.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>help</command></term>
|
|
<listitem>
|
|
<para>
|
|
print detailed help for another command
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>ipsec-site-connection-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create an IPsec site connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>ipsec-site-connection-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given IPsec site connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>ipsec-site-connection-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List IPsec site connections that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>ipsec-site-connection-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given IPsec site connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>ipsec-site-connection-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given IPsec site connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>l3-agent-list-hosting-router</command></term>
|
|
<listitem>
|
|
<para>
|
|
List L3 agents hosting a router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>l3-agent-router-add</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add a router to a L3 agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>l3-agent-router-remove</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a router from a L3 agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-agent-hosting-pool</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get loadbalancer agent hosting a pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-healthmonitor-associate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a mapping between a health monitor and a pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-healthmonitor-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a healthmonitor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-healthmonitor-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given healthmonitor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-healthmonitor-disassociate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a mapping from a health monitor to a pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-healthmonitor-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List healthmonitors that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-healthmonitor-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given healthmonitor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-healthmonitor-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given healthmonitor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-member-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-member-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-member-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List members that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-member-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-member-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-pool-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-pool-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-pool-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List pools that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-pool-list-on-agent</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the pools on a loadbalancer agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-pool-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-pool-stats</command></term>
|
|
<listitem>
|
|
<para>
|
|
Retrieve stats for a given pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-pool-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-vip-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a vip.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-vip-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given vip.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-vip-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List vips that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-vip-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given vip.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lb-vip-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given vip.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>meter-label-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a metering label for a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>meter-label-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given metering label.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>meter-label-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List metering labels that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>meter-label-rule-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a metering label rule for a given label.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>meter-label-rule-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given metering label.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>meter-label-rule-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List metering labels that belong to a given label.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>meter-label-rule-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given metering label rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>meter-label-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given metering label.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>nec-packet-filter-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a packet filter for a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>nec-packet-filter-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given packet filter.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>nec-packet-filter-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List packet filters that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>nec-packet-filter-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given packet filter.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>nec-packet-filter-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update packet filter's information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a network for a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-external-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List external networks that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-gateway-connect</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add an internal network interface to a router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-gateway-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a network gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-gateway-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given network gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-gateway-disconnect</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a network from a network gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-gateway-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List network gateways for a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-gateway-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given network gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-gateway-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update the name for a network gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List networks that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-list-on-dhcp-agent</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the networks on a DHCP agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update network's information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>nuage-netpartition-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a netpartition for a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>nuage-netpartition-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given netpartition.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>nuage-netpartition-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List netpartitions that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>nuage-netpartition-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given netpartition.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>port-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a port for a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>port-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given port.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>port-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List ports that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>port-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given port.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>port-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update port's information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>queue-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a queue.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>queue-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given queue.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>queue-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List queues that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>queue-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given queue.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete defined quotas of a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List quotas of all tenants who have non-default quota values.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show quotas of a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Define tenant's quotas not to use defaults.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a router for a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-gateway-clear</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove an external network gateway from a router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-gateway-set</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set the external network gateway for a router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-interface-add</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add an internal network interface to a router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-interface-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove an internal network interface from a router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List routers that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-list-on-l3-agent</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the routers on a L3 agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-port-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List ports that belong to a given tenant, with specified router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update router's information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>security-group-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>security-group-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>security-group-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List security groups that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>security-group-rule-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a security group rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>security-group-rule-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given security group rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>security-group-rule-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List security group rules that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>security-group-rule-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given security group rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>security-group-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>security-group-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-provider-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List service providers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>subnet-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a subnet for a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>subnet-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>subnet-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List subnets that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>subnet-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>subnet-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update subnet's information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-ikepolicy-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create an IKE policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-ikepolicy-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given IKE policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-ikepolicy-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List IKE policies that belong to a tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-ikepolicy-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given IKE policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-ikepolicy-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given IKE policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-ipsecpolicy-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create an IPsec policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-ipsecpolicy-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given IPsec policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-ipsecpolicy-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List ipsecpolicies that belongs to a given tenant connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-ipsecpolicy-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given IPsec policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-ipsecpolicy-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given IPsec policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-service-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a VPN service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-service-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a given VPN service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-service-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List VPN service configurations that belong to a given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-service-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information of a given VPN service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>vpn-service-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a given VPN service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_agent-delete">
|
|
<title>neutron agent-delete</title>
|
|
<screen><computeroutput>usage: neutron agent-delete [-h] [--request-format {json,xml}] AGENT</computeroutput></screen>
|
|
<para>
|
|
Delete a given agent.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>AGENT</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of agent to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_agent-list">
|
|
<title>neutron agent-list</title>
|
|
<screen><computeroutput>usage: neutron agent-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[--sort-key FIELD] [--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List agents.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_agent-show">
|
|
<title>neutron agent-show</title>
|
|
<screen><computeroutput>usage: neutron agent-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
AGENT</computeroutput></screen>
|
|
<para>
|
|
Show information of a given agent.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>AGENT</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of agent to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_agent-update">
|
|
<title>neutron agent-update</title>
|
|
<screen><computeroutput>usage: neutron agent-update [-h] [--request-format {json,xml}] AGENT</computeroutput></screen>
|
|
<para>
|
|
Update a given agent.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>AGENT</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of agent to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-credential-create">
|
|
<title>neutron cisco-credential-create</title>
|
|
<screen><computeroutput>usage: neutron cisco-credential-create [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--username USERNAME]
|
|
[--password PASSWORD]
|
|
credential_name credential_type</computeroutput></screen>
|
|
<para>
|
|
Creates a credential.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>credential_name</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name/IP address for credential.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>credential_type</command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of the credential.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--username USERNAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Username for the credential.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--password PASSWORD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Password for the credential.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-credential-delete">
|
|
<title>neutron cisco-credential-delete</title>
|
|
<screen><computeroutput>usage: neutron cisco-credential-delete [-h] [--request-format {json,xml}]
|
|
CREDENTIAL</computeroutput></screen>
|
|
<para>
|
|
Delete a given credential.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>CREDENTIAL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of credential to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-credential-list">
|
|
<title>neutron cisco-credential-list</title>
|
|
<screen><computeroutput>usage: neutron cisco-credential-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]</computeroutput></screen>
|
|
<para>
|
|
List credentials that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-credential-show">
|
|
<title>neutron cisco-credential-show</title>
|
|
<screen><computeroutput>usage: neutron cisco-credential-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
CREDENTIAL</computeroutput></screen>
|
|
<para>
|
|
Show information of a given credential.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>CREDENTIAL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of credential to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-network-profile-create">
|
|
<title>neutron cisco-network-profile-create</title>
|
|
<screen><computeroutput>usage: neutron cisco-network-profile-create [-h] [-f {shell,table,value}]
|
|
[-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--sub_type SUB_TYPE]
|
|
[--segment_range SEGMENT_RANGE]
|
|
[--physical_network PHYSICAL_NETWORK]
|
|
[--multicast_ip_range MULTICAST_IP_RANGE]
|
|
[--add-tenant ADD_TENANTS]
|
|
name
|
|
{vlan,overlay,multi-segment,trunk}</computeroutput></screen>
|
|
<para>
|
|
Creates a network profile.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>name</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name for network profile.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>{vlan,overlay,multi-segment,trunk}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Segment type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sub_type SUB_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sub-type for the segment. Available sub-types for
|
|
overlay segments: native, enhanced; For trunk
|
|
segments: vlan, overlay.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--segment_range SEGMENT_RANGE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Range for the segment.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--physical_network PHYSICAL_NETWORK</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name for the physical network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--multicast_ip_range MULTICAST_IP_RANGE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Multicast IPv4 range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--add-tenant ADD_TENANTS</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add tenant to the network profile. You can repeat this
|
|
option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-network-profile-delete">
|
|
<title>neutron cisco-network-profile-delete</title>
|
|
<screen><computeroutput>usage: neutron cisco-network-profile-delete [-h] [--request-format {json,xml}]
|
|
NETWORK_PROFILE</computeroutput></screen>
|
|
<para>
|
|
Delete a given network profile.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK_PROFILE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of network_profile to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-network-profile-list">
|
|
<title>neutron cisco-network-profile-list</title>
|
|
<screen><computeroutput>usage: neutron cisco-network-profile-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]</computeroutput></screen>
|
|
<para>
|
|
List network profiles that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-network-profile-show">
|
|
<title>neutron cisco-network-profile-show</title>
|
|
<screen><computeroutput>usage: neutron cisco-network-profile-show [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
NETWORK_PROFILE</computeroutput></screen>
|
|
<para>
|
|
Show information of a given network profile.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK_PROFILE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of network_profile to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-network-profile-update">
|
|
<title>neutron cisco-network-profile-update</title>
|
|
<screen><computeroutput>usage: neutron cisco-network-profile-update [-h] [--request-format {json,xml}]
|
|
[--remove-tenant REMOVE_TENANTS]
|
|
[--add-tenant ADD_TENANTS]
|
|
NETWORK_PROFILE</computeroutput></screen>
|
|
<para>
|
|
Update network profile's information.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK_PROFILE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of network_profile to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remove-tenant REMOVE_TENANTS</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove tenant from the network profile. You can repeat
|
|
this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--add-tenant ADD_TENANTS</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add tenant to the network profile. You can repeat this
|
|
option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-policy-profile-list">
|
|
<title>neutron cisco-policy-profile-list</title>
|
|
<screen><computeroutput>usage: neutron cisco-policy-profile-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]</computeroutput></screen>
|
|
<para>
|
|
List policy profiles that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-policy-profile-show">
|
|
<title>neutron cisco-policy-profile-show</title>
|
|
<screen><computeroutput>usage: neutron cisco-policy-profile-show [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
POLICY_PROFILE</computeroutput></screen>
|
|
<para>
|
|
Show information of a given policy profile.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>POLICY_PROFILE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of policy_profile to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_cisco-policy-profile-update">
|
|
<title>neutron cisco-policy-profile-update</title>
|
|
<screen><computeroutput>usage: neutron cisco-policy-profile-update [-h] [--request-format {json,xml}]
|
|
POLICY_PROFILE</computeroutput></screen>
|
|
<para>
|
|
Update policy profile's information.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>POLICY_PROFILE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of policy_profile to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_dhcp-agent-list-hosting-net">
|
|
<title>neutron dhcp-agent-list-hosting-net</title>
|
|
<screen><computeroutput>usage: neutron dhcp-agent-list-hosting-net [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
network</computeroutput></screen>
|
|
<para>
|
|
List DHCP agents hosting a network.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>network</command></term>
|
|
<listitem>
|
|
<para>
|
|
Network to query.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_dhcp-agent-network-add">
|
|
<title>neutron dhcp-agent-network-add</title>
|
|
<screen><computeroutput>usage: neutron dhcp-agent-network-add [-h] [--request-format {json,xml}]
|
|
dhcp_agent network</computeroutput></screen>
|
|
<para>
|
|
Add a network to a DHCP agent.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>dhcp_agent</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the DHCP agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>network</command></term>
|
|
<listitem>
|
|
<para>
|
|
Network to add.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_dhcp-agent-network-remove">
|
|
<title>neutron dhcp-agent-network-remove</title>
|
|
<screen><computeroutput>usage: neutron dhcp-agent-network-remove [-h] [--request-format {json,xml}]
|
|
dhcp_agent network</computeroutput></screen>
|
|
<para>
|
|
Remove a network from a DHCP agent.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>dhcp_agent</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the DHCP agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>network</command></term>
|
|
<listitem>
|
|
<para>
|
|
Network to remove.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_ext-list">
|
|
<title>neutron ext-list</title>
|
|
<screen><computeroutput>usage: neutron ext-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]</computeroutput></screen>
|
|
<para>
|
|
List all extensions.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_ext-show">
|
|
<title>neutron ext-show</title>
|
|
<screen><computeroutput>usage: neutron ext-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
EXTENSION</computeroutput></screen>
|
|
<para>
|
|
Show information of a given resource.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>EXTENSION</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of extension to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-create">
|
|
<title>neutron firewall-create</title>
|
|
<screen><computeroutput>usage: neutron firewall-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--name NAME]
|
|
[--description DESCRIPTION] [--shared]
|
|
[--admin-state-down]
|
|
POLICY</computeroutput></screen>
|
|
<para>
|
|
Create a firewall.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>POLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
Firewall policy name or ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name for the firewall.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Description for the firewall rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--shared</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set shared to True (default is False).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set admin state up to false.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-delete">
|
|
<title>neutron firewall-delete</title>
|
|
<screen><computeroutput>usage: neutron firewall-delete [-h] [--request-format {json,xml}] FIREWALL</computeroutput></screen>
|
|
<para>
|
|
Delete a given firewall.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-list">
|
|
<title>neutron firewall-list</title>
|
|
<screen><computeroutput>usage: neutron firewall-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List firewalls that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-policy-create">
|
|
<title>neutron firewall-policy-create</title>
|
|
<screen><computeroutput>usage: neutron firewall-policy-create [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--description DESCRIPTION] [--shared]
|
|
[--firewall-rules FIREWALL_RULES]
|
|
[--audited]
|
|
NAME</computeroutput></screen>
|
|
<para>
|
|
Create a firewall policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name for the firewall policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Description for the firewall policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--shared</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a shared policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--firewall-rules FIREWALL_RULES</command></term>
|
|
<listitem>
|
|
<para>
|
|
Ordered list of whitespace-delimited firewall rule
|
|
names or IDs; e.g., --firewall-rules "rule1 rule2"
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--audited</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sets audited to True.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-policy-delete">
|
|
<title>neutron firewall-policy-delete</title>
|
|
<screen><computeroutput>usage: neutron firewall-policy-delete [-h] [--request-format {json,xml}]
|
|
FIREWALL_POLICY</computeroutput></screen>
|
|
<para>
|
|
Delete a given firewall policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL_POLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall_policy to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-policy-insert-rule">
|
|
<title>neutron firewall-policy-insert-rule</title>
|
|
<screen><computeroutput>usage: neutron firewall-policy-insert-rule [-h] [--request-format {json,xml}]
|
|
[--insert-before FIREWALL_RULE]
|
|
[--insert-after FIREWALL_RULE]
|
|
FIREWALL_POLICY FIREWALL_RULE</computeroutput></screen>
|
|
<para>
|
|
Insert a rule into a given firewall policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL_POLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall_policy to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>FIREWALL_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
New rule to insert.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--insert-before FIREWALL_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Insert before this rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--insert-after FIREWALL_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Insert after this rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-policy-list">
|
|
<title>neutron firewall-policy-list</title>
|
|
<screen><computeroutput>usage: neutron firewall-policy-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List firewall policies that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-policy-remove-rule">
|
|
<title>neutron firewall-policy-remove-rule</title>
|
|
<screen><computeroutput>usage: neutron firewall-policy-remove-rule [-h] [--request-format {json,xml}]
|
|
FIREWALL_POLICY FIREWALL_RULE</computeroutput></screen>
|
|
<para>
|
|
Remove a rule from a given firewall policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL_POLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall_policy to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>FIREWALL_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Firewall rule to remove from policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-policy-show">
|
|
<title>neutron firewall-policy-show</title>
|
|
<screen><computeroutput>usage: neutron firewall-policy-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
FIREWALL_POLICY</computeroutput></screen>
|
|
<para>
|
|
Show information of a given firewall policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL_POLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall_policy to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-policy-update">
|
|
<title>neutron firewall-policy-update</title>
|
|
<screen><computeroutput>usage: neutron firewall-policy-update [-h] [--request-format {json,xml}]
|
|
FIREWALL_POLICY</computeroutput></screen>
|
|
<para>
|
|
Update a given firewall policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL_POLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall_policy to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-rule-create">
|
|
<title>neutron firewall-rule-create</title>
|
|
<screen><computeroutput>usage: neutron firewall-rule-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--name NAME]
|
|
[--description DESCRIPTION] [--shared]
|
|
[--source-ip-address SOURCE_IP_ADDRESS]
|
|
[--destination-ip-address DESTINATION_IP_ADDRESS]
|
|
[--source-port SOURCE_PORT]
|
|
[--destination-port DESTINATION_PORT]
|
|
[--enabled {True,False}] --protocol
|
|
{tcp,udp,icmp,any} --action {allow,deny}</computeroutput></screen>
|
|
<para>
|
|
Create a firewall rule.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name for the firewall rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Description for the firewall rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--shared</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set shared to True (default is False).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--source-ip-address SOURCE_IP_ADDRESS</command></term>
|
|
<listitem>
|
|
<para>
|
|
Source IP address or subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--destination-ip-address DESTINATION_IP_ADDRESS</command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination IP address or subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--source-port SOURCE_PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Source port (integer in [1, 65535] or range in a:b).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--destination-port DESTINATION_PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination port (integer in [1, 65535] or range in
|
|
a:b).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enabled {True,False}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Whether to enable or disable this rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protocol {tcp,udp,icmp,any}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Protocol for the firewall rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--action {allow,deny}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Action for the firewall rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-rule-delete">
|
|
<title>neutron firewall-rule-delete</title>
|
|
<screen><computeroutput>usage: neutron firewall-rule-delete [-h] [--request-format {json,xml}]
|
|
FIREWALL_RULE</computeroutput></screen>
|
|
<para>
|
|
Delete a given firewall rule.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall_rule to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-rule-list">
|
|
<title>neutron firewall-rule-list</title>
|
|
<screen><computeroutput>usage: neutron firewall-rule-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List firewall rules that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-rule-show">
|
|
<title>neutron firewall-rule-show</title>
|
|
<screen><computeroutput>usage: neutron firewall-rule-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
FIREWALL_RULE</computeroutput></screen>
|
|
<para>
|
|
Show information of a given firewall rule.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall_rule to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-rule-update">
|
|
<title>neutron firewall-rule-update</title>
|
|
<screen><computeroutput>usage: neutron firewall-rule-update [-h] [--request-format {json,xml}]
|
|
[--protocol {tcp,udp,icmp,any}]
|
|
FIREWALL_RULE</computeroutput></screen>
|
|
<para>
|
|
Update a given firewall rule.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall_rule to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protocol {tcp,udp,icmp,any}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Protocol for the firewall rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-show">
|
|
<title>neutron firewall-show</title>
|
|
<screen><computeroutput>usage: neutron firewall-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[-D] [-F FIELD]
|
|
FIREWALL</computeroutput></screen>
|
|
<para>
|
|
Show information of a given firewall.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_firewall-update">
|
|
<title>neutron firewall-update</title>
|
|
<screen><computeroutput>usage: neutron firewall-update [-h] [--request-format {json,xml}]
|
|
[--policy POLICY]
|
|
FIREWALL</computeroutput></screen>
|
|
<para>
|
|
Update a given firewall.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FIREWALL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of firewall to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--policy POLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
Firewall policy name or ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_floatingip-associate">
|
|
<title>neutron floatingip-associate</title>
|
|
<screen><computeroutput>usage: neutron floatingip-associate [-h] [--request-format {json,xml}]
|
|
[--fixed-ip-address FIXED_IP_ADDRESS]
|
|
FLOATINGIP_ID PORT</computeroutput></screen>
|
|
<para>
|
|
Create a mapping between a floating IP and a fixed IP.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FLOATINGIP_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the floating IP to associate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the port to be associated with the
|
|
floating IP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-ip-address FIXED_IP_ADDRESS</command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address on the port (only required if port has
|
|
multiple IPs).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_floatingip-create">
|
|
<title>neutron floatingip-create</title>
|
|
<screen><computeroutput>usage: neutron floatingip-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--port-id PORT_ID]
|
|
[--fixed-ip-address FIXED_IP_ADDRESS]
|
|
FLOATING_NETWORK</computeroutput></screen>
|
|
<para>
|
|
Create a floating IP for a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FLOATING_NETWORK</command></term>
|
|
<listitem>
|
|
<para>
|
|
Network name or ID to allocate floating IP from.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--port-id PORT_ID ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
of the port to be associated with the floating IP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-ip-address FIXED_IP_ADDRESS</command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address on the port (only required if port has
|
|
multiple IPs).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_floatingip-delete">
|
|
<title>neutron floatingip-delete</title>
|
|
<screen><computeroutput>usage: neutron floatingip-delete [-h] [--request-format {json,xml}] FLOATINGIP</computeroutput></screen>
|
|
<para>
|
|
Delete a given floating IP.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FLOATINGIP</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of floatingip to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_floatingip-disassociate">
|
|
<title>neutron floatingip-disassociate</title>
|
|
<screen><computeroutput>usage: neutron floatingip-disassociate [-h] [--request-format {json,xml}]
|
|
FLOATINGIP_ID</computeroutput></screen>
|
|
<para>
|
|
Remove a mapping from a floating IP to a fixed IP.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FLOATINGIP_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the floating IP to disassociate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_floatingip-list">
|
|
<title>neutron floatingip-list</title>
|
|
<screen><computeroutput>usage: neutron floatingip-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List floating IPs that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_floatingip-show">
|
|
<title>neutron floatingip-show</title>
|
|
<screen><computeroutput>usage: neutron floatingip-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[-D] [-F FIELD]
|
|
FLOATINGIP</computeroutput></screen>
|
|
<para>
|
|
Show information of a given floating IP.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>FLOATINGIP</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of floatingip to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_gateway-device-create">
|
|
<title>neutron gateway-device-create</title>
|
|
<screen><computeroutput>usage: neutron gateway-device-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--connector-type {stt,gre,ipsecgre,ipsecstt,bridge}]
|
|
--connector-ip CONNECTOR_IP
|
|
(--client-certificate CERT_DATA | --client-certificate-file CERT_FILE)
|
|
NAME</computeroutput></screen>
|
|
<para>
|
|
Create a network gateway device.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of network gateway device to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--connector-type {stt,gre,ipsecgre,ipsecstt,bridge}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of the transport zone connector to use for this
|
|
device. Valid values are gre, stt, ipsecgre, ipsecstt,
|
|
and bridge. Defaults to stt.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--connector-ip CONNECTOR_IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address for this device's transport connector. It
|
|
must correspond to the IP address of the interface
|
|
used for tenant traffic on the NSX gateway node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--client-certificate CERT_DATA</command></term>
|
|
<listitem>
|
|
<para>
|
|
PEM certificate used by the NSX gateway transport node
|
|
to authenticate with the NSX controller.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--client-certificate-file CERT_FILE</command></term>
|
|
<listitem>
|
|
<para>
|
|
File containing the PEM certificate used by the NSX
|
|
gateway transport node to authenticate with the NSX
|
|
controller.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_gateway-device-delete">
|
|
<title>neutron gateway-device-delete</title>
|
|
<screen><computeroutput>usage: neutron gateway-device-delete [-h] [--request-format {json,xml}]
|
|
GATEWAY_DEVICE</computeroutput></screen>
|
|
<para>
|
|
Delete a given network gateway device.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>GATEWAY_DEVICE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of gateway_device to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_gateway-device-list">
|
|
<title>neutron gateway-device-list</title>
|
|
<screen><computeroutput>usage: neutron gateway-device-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]</computeroutput></screen>
|
|
<para>
|
|
List network gateway devices for a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_gateway-device-show">
|
|
<title>neutron gateway-device-show</title>
|
|
<screen><computeroutput>usage: neutron gateway-device-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
GATEWAY_DEVICE</computeroutput></screen>
|
|
<para>
|
|
Show information for a given network gateway device.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>GATEWAY_DEVICE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of gateway_device to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_gateway-device-update">
|
|
<title>neutron gateway-device-update</title>
|
|
<screen><computeroutput>usage: neutron gateway-device-update [-h] [--request-format {json,xml}]
|
|
[--name NAME]
|
|
[--connector-type {stt,gre,ipsecgre,ipsecstt,bridge}]
|
|
[--connector-ip CONNECTOR_IP]
|
|
[--client-certificate CERT_DATA | --client-certificate-file CERT_FILE]
|
|
GATEWAY_DEVICE</computeroutput></screen>
|
|
<para>
|
|
Update a network gateway device.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>GATEWAY_DEVICE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of gateway_device to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
New name for network gateway device.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--connector-type {stt,gre,ipsecgre,ipsecstt,bridge}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of the transport zone connector to use for this
|
|
device. Valid values are gre, stt, ipsecgre, ipsecstt,
|
|
and bridge. Defaults to stt.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--connector-ip CONNECTOR_IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address for this device's transport connector. It
|
|
must correspond to the IP address of the interface
|
|
used for tenant traffic on the NSX gateway node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--client-certificate CERT_DATA</command></term>
|
|
<listitem>
|
|
<para>
|
|
PEM certificate used by the NSX gateway transport node
|
|
to authenticate with the NSX controller.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--client-certificate-file CERT_FILE</command></term>
|
|
<listitem>
|
|
<para>
|
|
File containing the PEM certificate used by the NSX
|
|
gateway transport node to authenticate with the NSX
|
|
controller.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_ipsec-site-connection-create">
|
|
<title>neutron ipsec-site-connection-create</title>
|
|
<screen><computeroutput>usage: neutron ipsec-site-connection-create [-h] [-f {shell,table,value}]
|
|
[-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--admin-state-down] [--name NAME]
|
|
[--description DESCRIPTION]
|
|
[--mtu MTU]
|
|
[--initiator {bi-directional,response-only}]
|
|
[--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
|
|
--vpnservice-id VPNSERVICE
|
|
--ikepolicy-id IKEPOLICY
|
|
--ipsecpolicy-id IPSECPOLICY
|
|
--peer-address PEER_ADDRESS
|
|
--peer-id PEER_ID --peer-cidr
|
|
PEER_CIDRS --psk PSK</computeroutput></screen>
|
|
<para>
|
|
Create an IPsec site connection.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set admin state up to false.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set friendly name for the connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a description for the connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--mtu MTU MTU</command></term>
|
|
<listitem>
|
|
<para>
|
|
size for the connection, default:1500
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--initiator {bi-directional,response-only}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Initiator state in lowercase, default:bi-directional
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dpd</command></term>
|
|
<listitem>
|
|
<para>
|
|
action=ACTION,interval=INTERVAL,timeout=TIMEOUT
|
|
Ipsec connection. Dead Peer Detection attributes.
|
|
'action'-hold,clear,disabled,restart,restart-by-peer.
|
|
'interval' and 'timeout' are non negative integers.
|
|
'interval' should be less than 'timeout' value.
|
|
'action', default:hold 'interval', default:30,
|
|
'timeout', default:120.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--vpnservice-id VPNSERVICE</command></term>
|
|
<listitem>
|
|
<para>
|
|
VPN service instance ID associated with this
|
|
connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ikepolicy-id IKEPOLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
IKE policy ID associated with this connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ipsecpolicy-id IPSECPOLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
IPsec policy ID associated with this connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--peer-address PEER_ADDRESS</command></term>
|
|
<listitem>
|
|
<para>
|
|
Peer gateway public IPv4/IPv6 address or FQDN.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--peer-id PEER_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Peer router identity for authentication. Can be
|
|
IPv4/IPv6 address, e-mail address, key id, or FQDN.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--peer-cidr PEER_CIDRS</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remote subnet(s) in CIDR format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--psk PSK</command></term>
|
|
<listitem>
|
|
<para>
|
|
Pre-shared key string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_ipsec-site-connection-delete">
|
|
<title>neutron ipsec-site-connection-delete</title>
|
|
<screen><computeroutput>usage: neutron ipsec-site-connection-delete [-h] [--request-format {json,xml}]
|
|
IPSEC_SITE_CONNECTION</computeroutput></screen>
|
|
<para>
|
|
Delete a given IPsec site connection.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>IPSEC_SITE_CONNECTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of ipsec_site_connection to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_ipsec-site-connection-list">
|
|
<title>neutron ipsec-site-connection-list</title>
|
|
<screen><computeroutput>usage: neutron ipsec-site-connection-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE]
|
|
[--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List IPsec site connections that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_ipsec-site-connection-show">
|
|
<title>neutron ipsec-site-connection-show</title>
|
|
<screen><computeroutput>usage: neutron ipsec-site-connection-show [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
IPSEC_SITE_CONNECTION</computeroutput></screen>
|
|
<para>
|
|
Show information of a given IPsec site connection.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>IPSEC_SITE_CONNECTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of ipsec_site_connection to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_ipsec-site-connection-update">
|
|
<title>neutron ipsec-site-connection-update</title>
|
|
<screen><computeroutput>usage: neutron ipsec-site-connection-update [-h] [--request-format {json,xml}]
|
|
[--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
|
|
IPSEC_SITE_CONNECTION</computeroutput></screen>
|
|
<para>
|
|
Update a given IPsec site connection.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>IPSEC_SITE_CONNECTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of ipsec_site_connection to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dpd</command></term>
|
|
<listitem>
|
|
<para>
|
|
action=ACTION,interval=INTERVAL,timeout=TIMEOUT
|
|
Ipsec connection. Dead Peer Detection attributes.
|
|
'action'-hold,clear,disabled,restart,restart-by-peer.
|
|
'interval' and 'timeout' are non negative integers.
|
|
'interval' should be less than 'timeout' value.
|
|
'action', default:hold 'interval', default:30,
|
|
'timeout', default:120.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_l3-agent-list-hosting-router">
|
|
<title>neutron l3-agent-list-hosting-router</title>
|
|
<screen><computeroutput>usage: neutron l3-agent-list-hosting-router [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
router</computeroutput></screen>
|
|
<para>
|
|
List L3 agents hosting a router.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>router</command></term>
|
|
<listitem>
|
|
<para>
|
|
Router to query.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_l3-agent-router-add">
|
|
<title>neutron l3-agent-router-add</title>
|
|
<screen><computeroutput>usage: neutron l3-agent-router-add [-h] [--request-format {json,xml}]
|
|
l3_agent router</computeroutput></screen>
|
|
<para>
|
|
Add a router to a L3 agent.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>l3_agent</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the L3 agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router</command></term>
|
|
<listitem>
|
|
<para>
|
|
Router to add.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_l3-agent-router-remove">
|
|
<title>neutron l3-agent-router-remove</title>
|
|
<screen><computeroutput>usage: neutron l3-agent-router-remove [-h] [--request-format {json,xml}]
|
|
l3_agent router</computeroutput></screen>
|
|
<para>
|
|
Remove a router from a L3 agent.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>l3_agent</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the L3 agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>router</command></term>
|
|
<listitem>
|
|
<para>
|
|
Router to remove.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-agent-hosting-pool">
|
|
<title>neutron lb-agent-hosting-pool</title>
|
|
<screen><computeroutput>usage: neutron lb-agent-hosting-pool [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
pool</computeroutput></screen>
|
|
<para>
|
|
Get loadbalancer agent hosting a pool. Deriving from ListCommand though server
|
|
will return only one agent to keep common output format for all agent
|
|
schedulers
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>pool</command></term>
|
|
<listitem>
|
|
<para>
|
|
Pool to query.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-healthmonitor-associate">
|
|
<title>neutron lb-healthmonitor-associate</title>
|
|
<screen><computeroutput>usage: neutron lb-healthmonitor-associate [-h] [--request-format {json,xml}]
|
|
HEALTH_MONITOR_ID POOL</computeroutput></screen>
|
|
<para>
|
|
Create a mapping between a health monitor and a pool.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>HEALTH_MONITOR_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Health monitor to associate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>POOL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the pool to be associated with the health
|
|
monitor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-healthmonitor-create">
|
|
<title>neutron lb-healthmonitor-create</title>
|
|
<screen><computeroutput>usage: neutron lb-healthmonitor-create [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE] [--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}</computeroutput></screen>
|
|
<para>
|
|
Create a healthmonitor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set admin state up to false.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--expected-codes EXPECTED_CODES</command></term>
|
|
<listitem>
|
|
<para>
|
|
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".
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--http-method HTTP_METHOD</command></term>
|
|
<listitem>
|
|
<para>
|
|
The HTTP method used for requests by the monitor of
|
|
type HTTP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--url-path URL_PATH</command></term>
|
|
<listitem>
|
|
<para>
|
|
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).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--delay DELAY</command></term>
|
|
<listitem>
|
|
<para>
|
|
The time in seconds between sending probes to members.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--max-retries MAX_RETRIES</command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of permissible connection failures before
|
|
changing the member status to INACTIVE. [1..10]
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--timeout TIMEOUT</command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--type {PING,TCP,HTTP,HTTPS}</command></term>
|
|
<listitem>
|
|
<para>
|
|
One of the predefined health monitor types.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-healthmonitor-delete">
|
|
<title>neutron lb-healthmonitor-delete</title>
|
|
<screen><computeroutput>usage: neutron lb-healthmonitor-delete [-h] [--request-format {json,xml}]
|
|
HEALTH_MONITOR</computeroutput></screen>
|
|
<para>
|
|
Delete a given healthmonitor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>HEALTH_MONITOR</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of health_monitor to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-healthmonitor-disassociate">
|
|
<title>neutron lb-healthmonitor-disassociate</title>
|
|
<screen><computeroutput>usage: neutron lb-healthmonitor-disassociate [-h]
|
|
[--request-format {json,xml}]
|
|
HEALTH_MONITOR_ID POOL</computeroutput></screen>
|
|
<para>
|
|
Remove a mapping from a health monitor to a pool.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>HEALTH_MONITOR_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Health monitor to associate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>POOL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the pool to be associated with the health
|
|
monitor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-healthmonitor-list">
|
|
<title>neutron lb-healthmonitor-list</title>
|
|
<screen><computeroutput>usage: neutron lb-healthmonitor-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List healthmonitors that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-healthmonitor-show">
|
|
<title>neutron lb-healthmonitor-show</title>
|
|
<screen><computeroutput>usage: neutron lb-healthmonitor-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
HEALTH_MONITOR</computeroutput></screen>
|
|
<para>
|
|
Show information of a given healthmonitor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>HEALTH_MONITOR</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of health_monitor to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-healthmonitor-update">
|
|
<title>neutron lb-healthmonitor-update</title>
|
|
<screen><computeroutput>usage: neutron lb-healthmonitor-update [-h] [--request-format {json,xml}]
|
|
HEALTH_MONITOR</computeroutput></screen>
|
|
<para>
|
|
Update a given healthmonitor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>HEALTH_MONITOR</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of health_monitor to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-member-create">
|
|
<title>neutron lb-member-create</title>
|
|
<screen><computeroutput>usage: neutron lb-member-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--admin-state-down]
|
|
[--weight WEIGHT] --address ADDRESS
|
|
--protocol-port PROTOCOL_PORT
|
|
POOL</computeroutput></screen>
|
|
<para>
|
|
Create a member.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>POOL</command></term>
|
|
<listitem>
|
|
<para>
|
|
Pool ID or name this vip belongs to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set admin state up to false.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--weight WEIGHT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Weight of pool member in the pool (default:1,
|
|
[0..256]).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--address ADDRESS IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
address of the pool member on the pool network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protocol-port PROTOCOL_PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Port on which the pool member listens for requests or
|
|
connections.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-member-delete">
|
|
<title>neutron lb-member-delete</title>
|
|
<screen><computeroutput>usage: neutron lb-member-delete [-h] [--request-format {json,xml}] MEMBER</computeroutput></screen>
|
|
<para>
|
|
Delete a given member.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>MEMBER</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of member to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-member-list">
|
|
<title>neutron lb-member-list</title>
|
|
<screen><computeroutput>usage: neutron lb-member-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List members that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-member-show">
|
|
<title>neutron lb-member-show</title>
|
|
<screen><computeroutput>usage: neutron lb-member-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[-D] [-F FIELD]
|
|
MEMBER</computeroutput></screen>
|
|
<para>
|
|
Show information of a given member.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>MEMBER</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of member to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-member-update">
|
|
<title>neutron lb-member-update</title>
|
|
<screen><computeroutput>usage: neutron lb-member-update [-h] [--request-format {json,xml}] MEMBER</computeroutput></screen>
|
|
<para>
|
|
Update a given member.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>MEMBER</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of member to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-pool-create">
|
|
<title>neutron lb-pool-create</title>
|
|
<screen><computeroutput>usage: neutron lb-pool-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--admin-state-down]
|
|
[--description DESCRIPTION] --lb-method
|
|
{ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP} --name
|
|
NAME --protocol {HTTP,HTTPS,TCP} --subnet-id
|
|
SUBNET [--provider PROVIDER]</computeroutput></screen>
|
|
<para>
|
|
Create a pool.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set admin state up to false.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of the pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--lb-method {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The algorithm used to distribute load between the
|
|
members of the pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
The name of the pool.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protocol {HTTP,HTTPS,TCP}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Protocol for balancing.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--subnet-id SUBNET</command></term>
|
|
<listitem>
|
|
<para>
|
|
The subnet on which the members of the pool will be
|
|
located.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--provider PROVIDER</command></term>
|
|
<listitem>
|
|
<para>
|
|
Provider name of loadbalancer service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-pool-delete">
|
|
<title>neutron lb-pool-delete</title>
|
|
<screen><computeroutput>usage: neutron lb-pool-delete [-h] [--request-format {json,xml}] POOL</computeroutput></screen>
|
|
<para>
|
|
Delete a given pool.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>POOL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of pool to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-pool-list">
|
|
<title>neutron lb-pool-list</title>
|
|
<screen><computeroutput>usage: neutron lb-pool-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List pools that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-pool-list-on-agent">
|
|
<title>neutron lb-pool-list-on-agent</title>
|
|
<screen><computeroutput>usage: neutron lb-pool-list-on-agent [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
lbaas_agent</computeroutput></screen>
|
|
<para>
|
|
List the pools on a loadbalancer agent.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>lbaas_agent</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the loadbalancer agent to query.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-pool-show">
|
|
<title>neutron lb-pool-show</title>
|
|
<screen><computeroutput>usage: neutron lb-pool-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[-D] [-F FIELD]
|
|
POOL</computeroutput></screen>
|
|
<para>
|
|
Show information of a given pool.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>POOL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of pool to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-pool-stats">
|
|
<title>neutron lb-pool-stats</title>
|
|
<screen><computeroutput>usage: neutron lb-pool-stats [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[-D] [-F FIELD]
|
|
POOL</computeroutput></screen>
|
|
<para>
|
|
Retrieve stats for a given pool.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>POOL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of pool to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-pool-update">
|
|
<title>neutron lb-pool-update</title>
|
|
<screen><computeroutput>usage: neutron lb-pool-update [-h] [--request-format {json,xml}] POOL</computeroutput></screen>
|
|
<para>
|
|
Update a given pool.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>POOL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of pool to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-vip-create">
|
|
<title>neutron lb-vip-create</title>
|
|
<screen><computeroutput>usage: neutron lb-vip-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--address ADDRESS]
|
|
[--admin-state-down]
|
|
[--connection-limit CONNECTION_LIMIT]
|
|
[--description DESCRIPTION] --name NAME
|
|
--protocol-port PROTOCOL_PORT --protocol
|
|
{TCP,HTTP,HTTPS} --subnet-id SUBNET
|
|
POOL</computeroutput></screen>
|
|
<para>
|
|
Create a vip.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>POOL</command></term>
|
|
<listitem>
|
|
<para>
|
|
Pool ID or name this vip belongs to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--address ADDRESS IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
address of the vip.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set admin state up to false.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--connection-limit CONNECTION_LIMIT</command></term>
|
|
<listitem>
|
|
<para>
|
|
The maximum number of connections per second allowed
|
|
for the vip. Positive integer or -1 for unlimited
|
|
(default).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of the vip.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the vip.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protocol-port PROTOCOL_PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
TCP port on which to listen for client traffic that is
|
|
associated with the vip address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protocol {TCP,HTTP,HTTPS}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Protocol for balancing.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--subnet-id SUBNET</command></term>
|
|
<listitem>
|
|
<para>
|
|
The subnet on which to allocate the vip address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-vip-delete">
|
|
<title>neutron lb-vip-delete</title>
|
|
<screen><computeroutput>usage: neutron lb-vip-delete [-h] [--request-format {json,xml}] VIP</computeroutput></screen>
|
|
<para>
|
|
Delete a given vip.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>VIP</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of vip to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-vip-list">
|
|
<title>neutron lb-vip-list</title>
|
|
<screen><computeroutput>usage: neutron lb-vip-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List vips that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-vip-show">
|
|
<title>neutron lb-vip-show</title>
|
|
<screen><computeroutput>usage: neutron lb-vip-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[-D] [-F FIELD]
|
|
VIP</computeroutput></screen>
|
|
<para>
|
|
Show information of a given vip.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>VIP</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of vip to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_lb-vip-update">
|
|
<title>neutron lb-vip-update</title>
|
|
<screen><computeroutput>usage: neutron lb-vip-update [-h] [--request-format {json,xml}] VIP</computeroutput></screen>
|
|
<para>
|
|
Update a given vip.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>VIP</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of vip to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_meter-label-create">
|
|
<title>neutron meter-label-create</title>
|
|
<screen><computeroutput>usage: neutron meter-label-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--description DESCRIPTION] [--shared]
|
|
NAME</computeroutput></screen>
|
|
<para>
|
|
Create a metering label for a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of metering label to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of metering label to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--shared</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set the label as shared.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_meter-label-delete">
|
|
<title>neutron meter-label-delete</title>
|
|
<screen><computeroutput>usage: neutron meter-label-delete [-h] [--request-format {json,xml}]
|
|
METERING_LABEL</computeroutput></screen>
|
|
<para>
|
|
Delete a given metering label.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>METERING_LABEL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of metering_label to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_meter-label-list">
|
|
<title>neutron meter-label-list</title>
|
|
<screen><computeroutput>usage: neutron meter-label-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List metering labels that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_meter-label-rule-create">
|
|
<title>neutron meter-label-rule-create</title>
|
|
<screen><computeroutput>usage: neutron meter-label-rule-create [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--direction {ingress,egress}]
|
|
[--excluded]
|
|
LABEL REMOTE_IP_PREFIX</computeroutput></screen>
|
|
<para>
|
|
Create a metering label rule for a given label.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>LABEL</command></term>
|
|
<listitem>
|
|
<para>
|
|
Id or Name of the label.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>REMOTE_IP_PREFIX</command></term>
|
|
<listitem>
|
|
<para>
|
|
CIDR to match on.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--direction {ingress,egress}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Direction of traffic, default: ingress.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--excluded</command></term>
|
|
<listitem>
|
|
<para>
|
|
Exclude this CIDR from the label, default: not
|
|
excluded.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_meter-label-rule-delete">
|
|
<title>neutron meter-label-rule-delete</title>
|
|
<screen><computeroutput>usage: neutron meter-label-rule-delete [-h] [--request-format {json,xml}]
|
|
METERING_LABEL_RULE</computeroutput></screen>
|
|
<para>
|
|
Delete a given metering label.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>METERING_LABEL_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of metering_label_rule to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_meter-label-rule-list">
|
|
<title>neutron meter-label-rule-list</title>
|
|
<screen><computeroutput>usage: neutron meter-label-rule-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List metering labels that belong to a given label.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_meter-label-rule-show">
|
|
<title>neutron meter-label-rule-show</title>
|
|
<screen><computeroutput>usage: neutron meter-label-rule-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
METERING_LABEL_RULE</computeroutput></screen>
|
|
<para>
|
|
Show information of a given metering label rule.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>METERING_LABEL_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of metering_label_rule to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_meter-label-show">
|
|
<title>neutron meter-label-show</title>
|
|
<screen><computeroutput>usage: neutron meter-label-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
METERING_LABEL</computeroutput></screen>
|
|
<para>
|
|
Show information of a given metering label.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>METERING_LABEL</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of metering_label to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_nec-packet-filter-create">
|
|
<title>neutron nec-packet-filter-create</title>
|
|
<screen><computeroutput>usage: neutron nec-packet-filter-create [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--admin-state-down] [--name NAME]
|
|
[--in-port PORT] [--src-mac SRC_MAC]
|
|
[--dst-mac DST_MAC]
|
|
[--eth-type ETH_TYPE]
|
|
[--protocol PROTOCOL]
|
|
[--src-cidr SRC_CIDR]
|
|
[--dst-cidr DST_CIDR]
|
|
[--src-port SRC_PORT]
|
|
[--dst-port DST_PORT]
|
|
[--priority PRIORITY]
|
|
[--action {allow,drop}]
|
|
NETWORK</computeroutput></screen>
|
|
<para>
|
|
Create a packet filter for a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK</command></term>
|
|
<listitem>
|
|
<para>
|
|
network to which this packet filter is applied
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set Admin State Up to false
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of this packet filter
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--in-port PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the input port
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--src-mac SRC_MAC</command></term>
|
|
<listitem>
|
|
<para>
|
|
Source MAC address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dst-mac DST_MAC</command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination MAC address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--eth-type ETH_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Ether Type. Integer [0:65535] (hex or decimal). E.g.,
|
|
0x0800 (IPv4), 0x0806 (ARP), 0x86DD (IPv6)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protocol PROTOCOL IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
Protocol. Protocol name or integer. Recognized
|
|
names are icmp, tcp, udp, arp (case insensitive).
|
|
Integer should be [0:255] (decimal or hex).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--src-cidr SRC_CIDR</command></term>
|
|
<listitem>
|
|
<para>
|
|
Source IP address CIDR
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dst-cidr DST_CIDR</command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination IP address CIDR
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--src-port SRC_PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Source port address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dst-port DST_PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination port address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--priority PRIORITY</command></term>
|
|
<listitem>
|
|
<para>
|
|
Priority of the filter. Integer of [0:65535]. Default:
|
|
30000.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--action {allow,drop}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Action of the filter. Default: allow
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_nec-packet-filter-delete">
|
|
<title>neutron nec-packet-filter-delete</title>
|
|
<screen><computeroutput>usage: neutron nec-packet-filter-delete [-h] [--request-format {json,xml}]
|
|
PACKET_FILTER</computeroutput></screen>
|
|
<para>
|
|
Delete a given packet filter.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>PACKET_FILTER</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of packet_filter to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_nec-packet-filter-list">
|
|
<title>neutron nec-packet-filter-list</title>
|
|
<screen><computeroutput>usage: neutron nec-packet-filter-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List packet filters that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_nec-packet-filter-show">
|
|
<title>neutron nec-packet-filter-show</title>
|
|
<screen><computeroutput>usage: neutron nec-packet-filter-show [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
PACKET_FILTER</computeroutput></screen>
|
|
<para>
|
|
Show information of a given packet filter.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>PACKET_FILTER</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of packet_filter to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_nec-packet-filter-update">
|
|
<title>neutron nec-packet-filter-update</title>
|
|
<screen><computeroutput>usage: neutron nec-packet-filter-update [-h] [--request-format {json,xml}]
|
|
[--admin-state {True,False}]
|
|
[--name NAME] [--src-mac SRC_MAC]
|
|
[--dst-mac DST_MAC]
|
|
[--eth-type ETH_TYPE]
|
|
[--protocol PROTOCOL]
|
|
[--src-cidr SRC_CIDR]
|
|
[--dst-cidr DST_CIDR]
|
|
[--src-port SRC_PORT]
|
|
[--dst-port DST_PORT]
|
|
[--priority PRIORITY]
|
|
[--action {allow,drop}]
|
|
PACKET_FILTER</computeroutput></screen>
|
|
<para>
|
|
Update packet filter's information.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>PACKET_FILTER</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of packet_filter to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state {True,False}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a value of Admin State Up
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of this packet filter
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--src-mac SRC_MAC</command></term>
|
|
<listitem>
|
|
<para>
|
|
Source MAC address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dst-mac DST_MAC</command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination MAC address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--eth-type ETH_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Ether Type. Integer [0:65535] (hex or decimal). E.g.,
|
|
0x0800 (IPv4), 0x0806 (ARP), 0x86DD (IPv6)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protocol PROTOCOL IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
Protocol. Protocol name or integer. Recognized
|
|
names are icmp, tcp, udp, arp (case insensitive).
|
|
Integer should be [0:255] (decimal or hex).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--src-cidr SRC_CIDR</command></term>
|
|
<listitem>
|
|
<para>
|
|
Source IP address CIDR
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dst-cidr DST_CIDR</command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination IP address CIDR
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--src-port SRC_PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Source port address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dst-port DST_PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination port address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--priority PRIORITY</command></term>
|
|
<listitem>
|
|
<para>
|
|
Priority of the filter. Integer of [0:65535].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--action {allow,drop}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Action of the filter.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-create">
|
|
<title>neutron net-create</title>
|
|
<screen><computeroutput>usage: neutron net-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--admin-state-down]
|
|
[--shared]
|
|
NAME</computeroutput></screen>
|
|
<para>
|
|
Create a network for a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of network to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set admin state up to false.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--shared</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set the network as shared.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-delete">
|
|
<title>neutron net-delete</title>
|
|
<screen><computeroutput>usage: neutron net-delete [-h] [--request-format {json,xml}] NETWORK</computeroutput></screen>
|
|
<para>
|
|
Delete a given network.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of network to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-external-list">
|
|
<title>neutron net-external-list</title>
|
|
<screen><computeroutput>usage: neutron net-external-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List external networks that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-gateway-connect">
|
|
<title>neutron net-gateway-connect</title>
|
|
<screen><computeroutput>usage: neutron net-gateway-connect [-h] [--request-format {json,xml}]
|
|
[--segmentation-type SEGMENTATION_TYPE]
|
|
[--segmentation-id SEGMENTATION_ID]
|
|
NET-GATEWAY-ID NETWORK-ID</computeroutput></screen>
|
|
<para>
|
|
Add an internal network interface to a router.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NET-GATEWAY-ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the network gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>NETWORK-ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the internal network to connect on the gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--segmentation-type SEGMENTATION_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
L2 segmentation strategy on the external side of the
|
|
gateway (e.g.: VLAN, FLAT).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--segmentation-id SEGMENTATION_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Identifier for the L2 segment on the external side of
|
|
the gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-gateway-create">
|
|
<title>neutron net-gateway-create</title>
|
|
<screen><computeroutput>usage: neutron net-gateway-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--device id=ID,interface_name=NAME_OR_ID]
|
|
NAME</computeroutput></screen>
|
|
<para>
|
|
Create a network gateway.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of network gateway to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--device</command></term>
|
|
<listitem>
|
|
<para>
|
|
id=ID,interface_name=NAME_OR_ID
|
|
Device info for this gateway. You can repeat this
|
|
option for multiple devices for HA gateways.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-gateway-delete">
|
|
<title>neutron net-gateway-delete</title>
|
|
<screen><computeroutput>usage: neutron net-gateway-delete [-h] [--request-format {json,xml}]
|
|
NETWORK_GATEWAY</computeroutput></screen>
|
|
<para>
|
|
Delete a given network gateway.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK_GATEWAY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of network_gateway to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-gateway-disconnect">
|
|
<title>neutron net-gateway-disconnect</title>
|
|
<screen><computeroutput>usage: neutron net-gateway-disconnect [-h] [--request-format {json,xml}]
|
|
[--segmentation-type SEGMENTATION_TYPE]
|
|
[--segmentation-id SEGMENTATION_ID]
|
|
NET-GATEWAY-ID NETWORK-ID</computeroutput></screen>
|
|
<para>
|
|
Remove a network from a network gateway.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NET-GATEWAY-ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the network gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>NETWORK-ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the internal network to connect on the gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--segmentation-type SEGMENTATION_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
L2 segmentation strategy on the external side of the
|
|
gateway (e.g.: VLAN, FLAT).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--segmentation-id SEGMENTATION_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Identifier for the L2 segment on the external side of
|
|
the gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-gateway-list">
|
|
<title>neutron net-gateway-list</title>
|
|
<screen><computeroutput>usage: neutron net-gateway-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]</computeroutput></screen>
|
|
<para>
|
|
List network gateways for a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-gateway-show">
|
|
<title>neutron net-gateway-show</title>
|
|
<screen><computeroutput>usage: neutron net-gateway-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
NETWORK_GATEWAY</computeroutput></screen>
|
|
<para>
|
|
Show information of a given network gateway.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK_GATEWAY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of network_gateway to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-gateway-update">
|
|
<title>neutron net-gateway-update</title>
|
|
<screen><computeroutput>usage: neutron net-gateway-update [-h] [--request-format {json,xml}]
|
|
NETWORK_GATEWAY</computeroutput></screen>
|
|
<para>
|
|
Update the name for a network gateway.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK_GATEWAY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of network_gateway to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-list">
|
|
<title>neutron net-list</title>
|
|
<screen><computeroutput>usage: neutron net-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List networks that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-list-on-dhcp-agent">
|
|
<title>neutron net-list-on-dhcp-agent</title>
|
|
<screen><computeroutput>usage: neutron net-list-on-dhcp-agent [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]
|
|
dhcp_agent</computeroutput></screen>
|
|
<para>
|
|
List the networks on a DHCP agent.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>dhcp_agent</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the DHCP agent.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-show">
|
|
<title>neutron net-show</title>
|
|
<screen><computeroutput>usage: neutron net-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
NETWORK</computeroutput></screen>
|
|
<para>
|
|
Show information of a given network.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of network to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_net-update">
|
|
<title>neutron net-update</title>
|
|
<screen><computeroutput>usage: neutron net-update [-h] [--request-format {json,xml}] NETWORK</computeroutput></screen>
|
|
<para>
|
|
Update network's information.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of network to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_nuage-netpartition-create">
|
|
<title>neutron nuage-netpartition-create</title>
|
|
<screen><computeroutput>usage: neutron nuage-netpartition-create [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
name</computeroutput></screen>
|
|
<para>
|
|
Create a netpartition for a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>name</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of netpartition to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_nuage-netpartition-delete">
|
|
<title>neutron nuage-netpartition-delete</title>
|
|
<screen><computeroutput>usage: neutron nuage-netpartition-delete [-h] [--request-format {json,xml}]
|
|
NET_PARTITION</computeroutput></screen>
|
|
<para>
|
|
Delete a given netpartition.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NET_PARTITION</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of net_partition to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_nuage-netpartition-list">
|
|
<title>neutron nuage-netpartition-list</title>
|
|
<screen><computeroutput>usage: neutron nuage-netpartition-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]</computeroutput></screen>
|
|
<para>
|
|
List netpartitions that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_nuage-netpartition-show">
|
|
<title>neutron nuage-netpartition-show</title>
|
|
<screen><computeroutput>usage: neutron nuage-netpartition-show [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
NET_PARTITION</computeroutput></screen>
|
|
<para>
|
|
Show information of a given netpartition.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NET_PARTITION</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of net_partition to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_port-create">
|
|
<title>neutron port-create</title>
|
|
<screen><computeroutput>usage: neutron port-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--name NAME]
|
|
[--admin-state-down] [--mac-address MAC_ADDRESS]
|
|
[--device-id DEVICE_ID]
|
|
[--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR]
|
|
[--security-group SECURITY_GROUP | --no-security-groups]
|
|
[--extra-dhcp-opt EXTRA_DHCP_OPTS]
|
|
NETWORK</computeroutput></screen>
|
|
<para>
|
|
Create a port for a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK</command></term>
|
|
<listitem>
|
|
<para>
|
|
Network ID or name this port belongs to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of this port.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set admin state up to false.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--mac-address MAC_ADDRESS</command></term>
|
|
<listitem>
|
|
<para>
|
|
MAC address of this port.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--device-id DEVICE_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Device ID of this port.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-ip</command></term>
|
|
<listitem>
|
|
<para>
|
|
subnet_id=SUBNET,ip_address=IP_ADDR
|
|
Desired IP and/or subnet for this port:
|
|
subnet_id=<name_or_id>,ip_address=<ip>.You can repeat
|
|
this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-group SECURITY_GROUP</command></term>
|
|
<listitem>
|
|
<para>
|
|
Security group associated with the port. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--no-security-groups</command></term>
|
|
<listitem>
|
|
<para>
|
|
Associate no security groups with the port.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--extra-dhcp-opt EXTRA_DHCP_OPTS</command></term>
|
|
<listitem>
|
|
<para>
|
|
Extra dhcp options to be assigned to this port:
|
|
opt_name=<dhcp_option_name>,opt_value=<value>. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_port-delete">
|
|
<title>neutron port-delete</title>
|
|
<screen><computeroutput>usage: neutron port-delete [-h] [--request-format {json,xml}] PORT</computeroutput></screen>
|
|
<para>
|
|
Delete a given port.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of port to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_port-list">
|
|
<title>neutron port-list</title>
|
|
<screen><computeroutput>usage: neutron port-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List ports that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_port-show">
|
|
<title>neutron port-show</title>
|
|
<screen><computeroutput>usage: neutron port-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
PORT</computeroutput></screen>
|
|
<para>
|
|
Show information of a given port.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of port to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_port-update">
|
|
<title>neutron port-update</title>
|
|
<screen><computeroutput>usage: neutron port-update [-h] [--request-format {json,xml}]
|
|
[--security-group SECURITY_GROUP | --no-security-groups]
|
|
[--extra-dhcp-opt EXTRA_DHCP_OPTS]
|
|
PORT</computeroutput></screen>
|
|
<para>
|
|
Update port's information.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of port to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-group SECURITY_GROUP</command></term>
|
|
<listitem>
|
|
<para>
|
|
Security group associated with the port. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--no-security-groups</command></term>
|
|
<listitem>
|
|
<para>
|
|
Associate no security groups with the port.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--extra-dhcp-opt EXTRA_DHCP_OPTS</command></term>
|
|
<listitem>
|
|
<para>
|
|
Extra dhcp options to be assigned to this port:
|
|
opt_name=<dhcp_option_name>,opt_value=<value>. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_queue-create">
|
|
<title>neutron queue-create</title>
|
|
<screen><computeroutput>usage: neutron queue-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--min MIN] [--max MAX]
|
|
[--qos-marking QOS_MARKING] [--default DEFAULT]
|
|
[--dscp DSCP]
|
|
NAME</computeroutput></screen>
|
|
<para>
|
|
Create a queue.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of queue.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min MIN</command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum rate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--max MAX</command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum rate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--qos-marking QOS_MARKING</command></term>
|
|
<listitem>
|
|
<para>
|
|
QOS marking as untrusted or trusted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--default DEFAULT</command></term>
|
|
<listitem>
|
|
<para>
|
|
If true all created ports will be the size of this
|
|
queue, if queue is not specified
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dscp DSCP</command></term>
|
|
<listitem>
|
|
<para>
|
|
Differentiated Services Code Point.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_queue-delete">
|
|
<title>neutron queue-delete</title>
|
|
<screen><computeroutput>usage: neutron queue-delete [-h] [--request-format {json,xml}] QOS_QUEUE</computeroutput></screen>
|
|
<para>
|
|
Delete a given queue.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>QOS_QUEUE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of qos_queue to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_queue-list">
|
|
<title>neutron queue-list</title>
|
|
<screen><computeroutput>usage: neutron queue-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]</computeroutput></screen>
|
|
<para>
|
|
List queues that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_queue-show">
|
|
<title>neutron queue-show</title>
|
|
<screen><computeroutput>usage: neutron queue-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
QOS_QUEUE</computeroutput></screen>
|
|
<para>
|
|
Show information of a given queue.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>QOS_QUEUE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of qos_queue to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_quota-delete">
|
|
<title>neutron quota-delete</title>
|
|
<screen><computeroutput>usage: neutron quota-delete [-h] [--request-format {json,xml}]
|
|
[--tenant-id tenant-id]</computeroutput></screen>
|
|
<para>
|
|
Delete defined quotas of a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id</command></term>
|
|
<listitem>
|
|
<para>
|
|
tenant-id
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_quota-list">
|
|
<title>neutron quota-list</title>
|
|
<screen><computeroutput>usage: neutron quota-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}]</computeroutput></screen>
|
|
<para>
|
|
List quotas of all tenants who have non-default quota values.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_quota-show">
|
|
<title>neutron quota-show</title>
|
|
<screen><computeroutput>usage: neutron quota-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[--tenant-id tenant-id]</computeroutput></screen>
|
|
<para>
|
|
Show quotas of a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id</command></term>
|
|
<listitem>
|
|
<para>
|
|
tenant-id
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_quota-update">
|
|
<title>neutron quota-update</title>
|
|
<screen><computeroutput>usage: neutron quota-update [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[--tenant-id tenant-id] [--network networks]
|
|
[--subnet subnets] [--port ports]
|
|
[--router routers] [--floatingip floatingips]
|
|
[--security-group security_groups]
|
|
[--security-group-rule security_group_rules]
|
|
[--vip vips] [--pool pools] [--member members]
|
|
[--health-monitor health_monitors]</computeroutput></screen>
|
|
<para>
|
|
Define tenant's quotas not to use defaults.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id</command></term>
|
|
<listitem>
|
|
<para>
|
|
tenant-id
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--network</command></term>
|
|
<listitem>
|
|
<para>
|
|
networks The limit of networks.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--subnet</command></term>
|
|
<listitem>
|
|
<para>
|
|
subnets The limit of subnets.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--port</command></term>
|
|
<listitem>
|
|
<para>
|
|
ports The limit of ports.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--router</command></term>
|
|
<listitem>
|
|
<para>
|
|
routers The limit of routers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--floatingip</command></term>
|
|
<listitem>
|
|
<para>
|
|
floatingips
|
|
The limit of floating IPs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-group</command></term>
|
|
<listitem>
|
|
<para>
|
|
security_groups
|
|
The limit of security groups.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-group-rule</command></term>
|
|
<listitem>
|
|
<para>
|
|
security_group_rules
|
|
The limit of security groups rules.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--vip</command></term>
|
|
<listitem>
|
|
<para>
|
|
vips The limit of vips.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--pool</command></term>
|
|
<listitem>
|
|
<para>
|
|
pools The limit of pools.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--member</command></term>
|
|
<listitem>
|
|
<para>
|
|
members The limit of pool members.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--health-monitor</command></term>
|
|
<listitem>
|
|
<para>
|
|
health_monitors
|
|
The limit of health monitors.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-create">
|
|
<title>neutron router-create</title>
|
|
<screen><computeroutput>usage: neutron router-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--admin-state-down]
|
|
[--distributed {True,False}] [--ha {True,False}]
|
|
NAME</computeroutput></screen>
|
|
<para>
|
|
Create a router for a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of router to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set admin state up to false.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--distributed {True,False}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a distributed router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ha {True,False}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a highly available router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-delete">
|
|
<title>neutron router-delete</title>
|
|
<screen><computeroutput>usage: neutron router-delete [-h] [--request-format {json,xml}] ROUTER</computeroutput></screen>
|
|
<para>
|
|
Delete a given router.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>ROUTER</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of router to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-gateway-clear">
|
|
<title>neutron router-gateway-clear</title>
|
|
<screen><computeroutput>usage: neutron router-gateway-clear [-h] [--request-format {json,xml}]
|
|
router-id</computeroutput></screen>
|
|
<para>
|
|
Remove an external network gateway from a router.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>router-id</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-gateway-set">
|
|
<title>neutron router-gateway-set</title>
|
|
<screen><computeroutput>usage: neutron router-gateway-set [-h] [--request-format {json,xml}]
|
|
[--disable-snat]
|
|
router-id external-network-id</computeroutput></screen>
|
|
<para>
|
|
Set the external network gateway for a router.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>router-id</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>external-network-id</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the external network for the gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable-snat</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable source NAT on the router gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-interface-add">
|
|
<title>neutron router-interface-add</title>
|
|
<screen><computeroutput>usage: neutron router-interface-add [-h] [--request-format {json,xml}]
|
|
router-id INTERFACE</computeroutput></screen>
|
|
<para>
|
|
Add an internal network interface to a router.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>router-id</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>INTERFACE</command></term>
|
|
<listitem>
|
|
<para>
|
|
The format is "SUBNET|subnet=SUBNET|port=PORT". Either
|
|
a subnet or port must be specified. Both ID and name
|
|
are accepted as SUBNET or PORT. Note that "subnet="
|
|
can be omitted when specifying a subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-interface-delete">
|
|
<title>neutron router-interface-delete</title>
|
|
<screen><computeroutput>usage: neutron router-interface-delete [-h] [--request-format {json,xml}]
|
|
router-id INTERFACE</computeroutput></screen>
|
|
<para>
|
|
Remove an internal network interface from a router.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>router-id</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the router.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>INTERFACE</command></term>
|
|
<listitem>
|
|
<para>
|
|
The format is "SUBNET|subnet=SUBNET|port=PORT". Either
|
|
a subnet or port must be specified. Both ID and name
|
|
are accepted as SUBNET or PORT. Note that "subnet="
|
|
can be omitted when specifying a subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-list">
|
|
<title>neutron router-list</title>
|
|
<screen><computeroutput>usage: neutron router-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List routers that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-list-on-l3-agent">
|
|
<title>neutron router-list-on-l3-agent</title>
|
|
<screen><computeroutput>usage: neutron router-list-on-l3-agent [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
l3_agent</computeroutput></screen>
|
|
<para>
|
|
List the routers on a L3 agent.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>l3_agent</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the L3 agent to query.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-port-list">
|
|
<title>neutron router-port-list</title>
|
|
<screen><computeroutput>usage: neutron router-port-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]
|
|
router</computeroutput></screen>
|
|
<para>
|
|
List ports that belong to a given tenant, with specified router.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>router</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of router to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-show">
|
|
<title>neutron router-show</title>
|
|
<screen><computeroutput>usage: neutron router-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[-D] [-F FIELD]
|
|
ROUTER</computeroutput></screen>
|
|
<para>
|
|
Show information of a given router.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>ROUTER</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of router to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_router-update">
|
|
<title>neutron router-update</title>
|
|
<screen><computeroutput>usage: neutron router-update [-h] [--request-format {json,xml}] ROUTER</computeroutput></screen>
|
|
<para>
|
|
Update router's information.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>ROUTER</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of router to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_security-group-create">
|
|
<title>neutron security-group-create</title>
|
|
<screen><computeroutput>usage: neutron security-group-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--description DESCRIPTION]
|
|
NAME</computeroutput></screen>
|
|
<para>
|
|
Create a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_security-group-delete">
|
|
<title>neutron security-group-delete</title>
|
|
<screen><computeroutput>usage: neutron security-group-delete [-h] [--request-format {json,xml}]
|
|
SECURITY_GROUP</computeroutput></screen>
|
|
<para>
|
|
Delete a given security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>SECURITY_GROUP</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of security_group to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_security-group-list">
|
|
<title>neutron security-group-list</title>
|
|
<screen><computeroutput>usage: neutron security-group-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List security groups that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_security-group-rule-create">
|
|
<title>neutron security-group-rule-create</title>
|
|
<screen><computeroutput>usage: neutron security-group-rule-create [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--direction {ingress,egress}]
|
|
[--ethertype ETHERTYPE]
|
|
[--protocol PROTOCOL]
|
|
[--port-range-min PORT_RANGE_MIN]
|
|
[--port-range-max PORT_RANGE_MAX]
|
|
[--remote-ip-prefix REMOTE_IP_PREFIX]
|
|
[--remote-group-id REMOTE_GROUP]
|
|
SECURITY_GROUP</computeroutput></screen>
|
|
<para>
|
|
Create a security group rule.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>SECURITY_GROUP</command></term>
|
|
<listitem>
|
|
<para>
|
|
Security group name or ID to add rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--direction {ingress,egress}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Direction of traffic: ingress/egress.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ethertype ETHERTYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
IPv4/IPv6
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protocol PROTOCOL</command></term>
|
|
<listitem>
|
|
<para>
|
|
Protocol of packet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--port-range-min PORT_RANGE_MIN</command></term>
|
|
<listitem>
|
|
<para>
|
|
Starting port range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--port-range-max PORT_RANGE_MAX</command></term>
|
|
<listitem>
|
|
<para>
|
|
Ending port range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remote-ip-prefix REMOTE_IP_PREFIX</command></term>
|
|
<listitem>
|
|
<para>
|
|
CIDR to match on.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remote-group-id REMOTE_GROUP</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remote security group name or ID to apply rule.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_security-group-rule-delete">
|
|
<title>neutron security-group-rule-delete</title>
|
|
<screen><computeroutput>usage: neutron security-group-rule-delete [-h] [--request-format {json,xml}]
|
|
SECURITY_GROUP_RULE</computeroutput></screen>
|
|
<para>
|
|
Delete a given security group rule.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>SECURITY_GROUP_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of security_group_rule to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_security-group-rule-list">
|
|
<title>neutron security-group-rule-list</title>
|
|
<screen><computeroutput>usage: neutron security-group-rule-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE]
|
|
[--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]
|
|
[--no-nameconv]</computeroutput></screen>
|
|
<para>
|
|
List security group rules that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--no-nameconv</command></term>
|
|
<listitem>
|
|
<para>
|
|
Do not convert security group ID to its name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_security-group-rule-show">
|
|
<title>neutron security-group-rule-show</title>
|
|
<screen><computeroutput>usage: neutron security-group-rule-show [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
SECURITY_GROUP_RULE</computeroutput></screen>
|
|
<para>
|
|
Show information of a given security group rule.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>SECURITY_GROUP_RULE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of security_group_rule to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_security-group-show">
|
|
<title>neutron security-group-show</title>
|
|
<screen><computeroutput>usage: neutron security-group-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
SECURITY_GROUP</computeroutput></screen>
|
|
<para>
|
|
Show information of a given security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>SECURITY_GROUP</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of security_group to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_security-group-update">
|
|
<title>neutron security-group-update</title>
|
|
<screen><computeroutput>usage: neutron security-group-update [-h] [--request-format {json,xml}]
|
|
[--name NAME] [--description DESCRIPTION]
|
|
SECURITY_GROUP</computeroutput></screen>
|
|
<para>
|
|
Update a given security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>SECURITY_GROUP</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of security_group to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_service-provider-list">
|
|
<title>neutron service-provider-list</title>
|
|
<screen><computeroutput>usage: neutron service-provider-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List service providers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_subnet-create">
|
|
<title>neutron subnet-create</title>
|
|
<screen><computeroutput>usage: neutron subnet-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--name NAME]
|
|
[--gateway GATEWAY_IP] [--no-gateway]
|
|
[--allocation-pool start=IP_ADDR,end=IP_ADDR]
|
|
[--host-route destination=CIDR,nexthop=IP_ADDR]
|
|
[--dns-nameserver DNS_NAMESERVER]
|
|
[--disable-dhcp] [--enable-dhcp]
|
|
[--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
|
|
[--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
|
|
[--ip-version {4,6}]
|
|
NETWORK CIDR</computeroutput></screen>
|
|
<para>
|
|
Create a subnet for a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NETWORK</command></term>
|
|
<listitem>
|
|
<para>
|
|
Network ID or name this subnet belongs to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>CIDR</command></term>
|
|
<listitem>
|
|
<para>
|
|
CIDR of subnet to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of this subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--gateway GATEWAY_IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
Gateway IP of this subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--no-gateway</command></term>
|
|
<listitem>
|
|
<para>
|
|
No distribution of gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--allocation-pool</command></term>
|
|
<listitem>
|
|
<para>
|
|
start=IP_ADDR,end=IP_ADDR
|
|
Allocation pool IP addresses for this subnet (This
|
|
option can be repeated).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--host-route</command></term>
|
|
<listitem>
|
|
<para>
|
|
destination=CIDR,nexthop=IP_ADDR
|
|
Additional route (This option can be repeated).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dns-nameserver DNS_NAMESERVER</command></term>
|
|
<listitem>
|
|
<para>
|
|
DNS name server for this subnet (This option can be
|
|
repeated).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable-dhcp</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable DHCP for this subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable-dhcp</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable DHCP for this subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}</command></term>
|
|
<listitem>
|
|
<para>
|
|
IPv6 RA (Router Advertisement) mode.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}</command></term>
|
|
<listitem>
|
|
<para>
|
|
IPv6 address mode.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ip-version {4,6} IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
version to use, default is 4.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_subnet-delete">
|
|
<title>neutron subnet-delete</title>
|
|
<screen><computeroutput>usage: neutron subnet-delete [-h] [--request-format {json,xml}] SUBNET</computeroutput></screen>
|
|
<para>
|
|
Delete a given subnet.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>SUBNET</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of subnet to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_subnet-list">
|
|
<title>neutron subnet-list</title>
|
|
<screen><computeroutput>usage: neutron subnet-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List subnets that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_subnet-show">
|
|
<title>neutron subnet-show</title>
|
|
<screen><computeroutput>usage: neutron subnet-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--request-format {json,xml}]
|
|
[-D] [-F FIELD]
|
|
SUBNET</computeroutput></screen>
|
|
<para>
|
|
Show information of a given subnet.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>SUBNET</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of subnet to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_subnet-update">
|
|
<title>neutron subnet-update</title>
|
|
<screen><computeroutput>usage: neutron subnet-update [-h] [--request-format {json,xml}] [--name NAME]
|
|
[--gateway GATEWAY_IP] [--no-gateway]
|
|
[--allocation-pool start=IP_ADDR,end=IP_ADDR]
|
|
[--host-route destination=CIDR,nexthop=IP_ADDR]
|
|
[--dns-nameserver DNS_NAMESERVER]
|
|
[--disable-dhcp] [--enable-dhcp]
|
|
[--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
|
|
[--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
|
|
SUBNET</computeroutput></screen>
|
|
<para>
|
|
Update subnet's information.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>SUBNET</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of subnet to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of this subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--gateway GATEWAY_IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
Gateway IP of this subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--no-gateway</command></term>
|
|
<listitem>
|
|
<para>
|
|
No distribution of gateway.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--allocation-pool</command></term>
|
|
<listitem>
|
|
<para>
|
|
start=IP_ADDR,end=IP_ADDR
|
|
Allocation pool IP addresses for this subnet (This
|
|
option can be repeated).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--host-route</command></term>
|
|
<listitem>
|
|
<para>
|
|
destination=CIDR,nexthop=IP_ADDR
|
|
Additional route (This option can be repeated).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dns-nameserver DNS_NAMESERVER</command></term>
|
|
<listitem>
|
|
<para>
|
|
DNS name server for this subnet (This option can be
|
|
repeated).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable-dhcp</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable DHCP for this subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable-dhcp</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable DHCP for this subnet.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}</command></term>
|
|
<listitem>
|
|
<para>
|
|
IPv6 RA (Router Advertisement) mode.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}</command></term>
|
|
<listitem>
|
|
<para>
|
|
IPv6 address mode.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-ikepolicy-create">
|
|
<title>neutron vpn-ikepolicy-create</title>
|
|
<screen><computeroutput>usage: neutron vpn-ikepolicy-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--description DESCRIPTION]
|
|
[--auth-algorithm {sha1}]
|
|
[--encryption-algorithm ENCRYPTION_ALGORITHM]
|
|
[--phase1-negotiation-mode {main}]
|
|
[--ike-version {v1,v2}]
|
|
[--pfs {group2,group5,group14}]
|
|
[--lifetime units=UNITS,value=VALUE]
|
|
NAME</computeroutput></screen>
|
|
<para>
|
|
Create an IKE policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the IKE policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of the IKE policy
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--auth-algorithm {sha1}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication algorithm in lowercase. Default:sha1
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--encryption-algorithm ENCRYPTION_ALGORITHM</command></term>
|
|
<listitem>
|
|
<para>
|
|
Encryption algorithm in lowercase, default:aes-128
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--phase1-negotiation-mode {main}</command></term>
|
|
<listitem>
|
|
<para>
|
|
IKE Phase1 negotiation mode in lowercase, default:main
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ike-version {v1,v2}</command></term>
|
|
<listitem>
|
|
<para>
|
|
IKE version in lowercase, default:v1
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--pfs {group2,group5,group14}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perfect Forward Secrecy in lowercase, default:group5
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--lifetime</command></term>
|
|
<listitem>
|
|
<para>
|
|
units=UNITS,value=VALUE
|
|
IKE lifetime attributes. 'units'-seconds,
|
|
default:seconds. 'value'-non negative integer,
|
|
default:3600.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-ikepolicy-delete">
|
|
<title>neutron vpn-ikepolicy-delete</title>
|
|
<screen><computeroutput>usage: neutron vpn-ikepolicy-delete [-h] [--request-format {json,xml}]
|
|
IKEPOLICY</computeroutput></screen>
|
|
<para>
|
|
Delete a given IKE policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>IKEPOLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of ikepolicy to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-ikepolicy-list">
|
|
<title>neutron vpn-ikepolicy-list</title>
|
|
<screen><computeroutput>usage: neutron vpn-ikepolicy-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List IKE policies that belong to a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-ikepolicy-show">
|
|
<title>neutron vpn-ikepolicy-show</title>
|
|
<screen><computeroutput>usage: neutron vpn-ikepolicy-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
IKEPOLICY</computeroutput></screen>
|
|
<para>
|
|
Show information of a given IKE policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>IKEPOLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of ikepolicy to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-ikepolicy-update">
|
|
<title>neutron vpn-ikepolicy-update</title>
|
|
<screen><computeroutput>usage: neutron vpn-ikepolicy-update [-h] [--request-format {json,xml}]
|
|
[--lifetime units=UNITS,value=VALUE]
|
|
IKEPOLICY</computeroutput></screen>
|
|
<para>
|
|
Update a given IKE policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>IKEPOLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of ikepolicy to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--lifetime</command></term>
|
|
<listitem>
|
|
<para>
|
|
units=UNITS,value=VALUE
|
|
IKE lifetime attributes. 'units'-seconds,
|
|
default:seconds. 'value'-non negative integer,
|
|
default:3600.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-ipsecpolicy-create">
|
|
<title>neutron vpn-ipsecpolicy-create</title>
|
|
<screen><computeroutput>usage: neutron vpn-ipsecpolicy-create [-h] [-f {shell,table,value}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID]
|
|
[--description DESCRIPTION]
|
|
[--transform-protocol {esp,ah,ah-esp}]
|
|
[--auth-algorithm {sha1}]
|
|
[--encryption-algorithm ENCRYPTION_ALGORITHM]
|
|
[--encapsulation-mode {tunnel,transport}]
|
|
[--pfs {group2,group5,group14}]
|
|
[--lifetime units=UNITS,value=VALUE]
|
|
NAME</computeroutput></screen>
|
|
<para>
|
|
Create an IPsec policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the IPsec policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of the IPsec policy.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--transform-protocol {esp,ah,ah-esp}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Transform protocol in lowercase, default:esp
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--auth-algorithm {sha1}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication algorithm in lowercase, default:sha1
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--encryption-algorithm ENCRYPTION_ALGORITHM</command></term>
|
|
<listitem>
|
|
<para>
|
|
Encryption algorithm in lowercase, default:aes-128
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--encapsulation-mode {tunnel,transport}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Encapsulation mode in lowercase, default:tunnel
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--pfs {group2,group5,group14}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perfect Forward Secrecy in lowercase, default:group5
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--lifetime</command></term>
|
|
<listitem>
|
|
<para>
|
|
units=UNITS,value=VALUE
|
|
IPsec lifetime attributes. 'units'-seconds,
|
|
default:seconds. 'value'-non negative integer,
|
|
default:3600.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-ipsecpolicy-delete">
|
|
<title>neutron vpn-ipsecpolicy-delete</title>
|
|
<screen><computeroutput>usage: neutron vpn-ipsecpolicy-delete [-h] [--request-format {json,xml}]
|
|
IPSECPOLICY</computeroutput></screen>
|
|
<para>
|
|
Delete a given IPsec policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>IPSECPOLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of ipsecpolicy to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-ipsecpolicy-list">
|
|
<title>neutron vpn-ipsecpolicy-list</title>
|
|
<screen><computeroutput>usage: neutron vpn-ipsecpolicy-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD] [-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List ipsecpolicies that belongs to a given tenant connection.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-ipsecpolicy-show">
|
|
<title>neutron vpn-ipsecpolicy-show</title>
|
|
<screen><computeroutput>usage: neutron vpn-ipsecpolicy-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D]
|
|
[-F FIELD]
|
|
IPSECPOLICY</computeroutput></screen>
|
|
<para>
|
|
Show information of a given IPsec policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>IPSECPOLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of ipsecpolicy to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-ipsecpolicy-update">
|
|
<title>neutron vpn-ipsecpolicy-update</title>
|
|
<screen><computeroutput>usage: neutron vpn-ipsecpolicy-update [-h] [--request-format {json,xml}]
|
|
[--lifetime units=UNITS,value=VALUE]
|
|
IPSECPOLICY</computeroutput></screen>
|
|
<para>
|
|
Update a given IPsec policy.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>IPSECPOLICY</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of ipsecpolicy to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--lifetime</command></term>
|
|
<listitem>
|
|
<para>
|
|
units=UNITS,value=VALUE
|
|
IPsec lifetime attributes. 'units'-seconds,
|
|
default:seconds. 'value'-non negative integer,
|
|
default:3600.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-service-create">
|
|
<title>neutron vpn-service-create</title>
|
|
<screen><computeroutput>usage: neutron vpn-service-create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--request-format {json,xml}]
|
|
[--tenant-id TENANT_ID] [--admin-state-down]
|
|
[--name NAME] [--description DESCRIPTION]
|
|
ROUTER SUBNET</computeroutput></screen>
|
|
<para>
|
|
Create a VPN service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>ROUTER</command></term>
|
|
<listitem>
|
|
<para>
|
|
Router unique identifier for the VPN service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>SUBNET</command></term>
|
|
<listitem>
|
|
<para>
|
|
Subnet unique identifier for the VPN service
|
|
deployment.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
The owner tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--admin-state-down</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set admin state up to false.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a name for the VPN service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description DESCRIPTION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a description for the VPN service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-service-delete">
|
|
<title>neutron vpn-service-delete</title>
|
|
<screen><computeroutput>usage: neutron vpn-service-delete [-h] [--request-format {json,xml}]
|
|
VPNSERVICE</computeroutput></screen>
|
|
<para>
|
|
Delete a given VPN service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>VPNSERVICE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of vpnservice to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-service-list">
|
|
<title>neutron vpn-service-list</title>
|
|
<screen><computeroutput>usage: neutron vpn-service-list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
[-P SIZE] [--sort-key FIELD]
|
|
[--sort-dir {asc,desc}]</computeroutput></screen>
|
|
<para>
|
|
List VPN service configurations that belong to a given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P SIZE, --page-size SIZE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify retrieve unit of each request, then split one
|
|
request to several requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list by the specified fields in the
|
|
specified directions. You can repeat this option, but
|
|
you must specify an equal number of sort_dir and
|
|
sort_key values. Extra sort_dir options are ignored.
|
|
Missing sort_dir options use the default asc value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sorts the list in the specified direction. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-service-show">
|
|
<title>neutron vpn-service-show</title>
|
|
<screen><computeroutput>usage: neutron vpn-service-show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--request-format {json,xml}] [-D] [-F FIELD]
|
|
VPNSERVICE</computeroutput></screen>
|
|
<para>
|
|
Show information of a given VPN service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>VPNSERVICE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of vpnservice to look up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-D, --show-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-F FIELD, --field FIELD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the field(s) to be returned by server. You can
|
|
repeat this option.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="neutronclient_subcommand_vpn-service-update">
|
|
<title>neutron vpn-service-update</title>
|
|
<screen><computeroutput>usage: neutron vpn-service-update [-h] [--request-format {json,xml}]
|
|
VPNSERVICE</computeroutput></screen>
|
|
<para>
|
|
Update a given VPN service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command>VPNSERVICE</command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of vpnservice to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-format {json,xml}</command></term>
|
|
<listitem>
|
|
<para>
|
|
The XML or JSON request format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</chapter>
|