diff --git a/doc/cli-reference/bk-cli-reference.xml b/doc/cli-reference/bk-cli-reference.xml index 97b06344d2..36e7fe8432 100644 --- a/doc/cli-reference/bk-cli-reference.xml +++ b/doc/cli-reference/bk-cli-reference.xml @@ -85,7 +85,7 @@ - + diff --git a/doc/cli-reference/ch_cli_neutron-debug_commands.xml b/doc/cli-reference/ch_cli_neutron-debug_commands.xml deleted file mode 100644 index 51ced60e3e..0000000000 --- a/doc/cli-reference/ch_cli_neutron-debug_commands.xml +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - - - neutron-debug command-line client - The neutron-debug client is an extension - to the neutron command-line interface (CLI) for the OpenStack - neutron-debug tool. This chapter documents - neutron-debug version 2.3.0. - For help on a specific neutron-debug - command, enter: - $ neutron-debug COMMAND - -
- neutron-debug usage - [--os-password <auth-password>] - [--os-tenant-name <auth-tenant-name>] - [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] - [--os-region-name <region-name>] [--service-type <service-type>] - [--service-name <service-name>] - [--volume-service-name <volume-service-name>] - [--endpoint-type <endpoint-type>] - [--os-volume-api-version <volume-api-ver>] - [--os-cacert <ca-certificate>] [--retries <retries>] - <subcommand> ... - - - Subcommands - - probe-create - - - Create probe port - create port and interface within a network namespace. - - - - - probe-list - - - List all probes. - - - - - probe-clear - - - Clear all probes. - - - - - probe-delete - - - Delete probe - delete port then delete the namespace. - - - - - probe-exec - - - Execute commands in the namespace of the probe. - - - - - ping-all - - - ping-all is an all-in-one command to ping all fixed IPs in a specified network. - - - - -
-
- neutron-debug optional arguments - - - --version - - Show version number and exit. - - - - -v, --verbose, --debug - - Increase verbosity of output and show tracebacks on - errors. Can be repeated. - - - - -q, --quiet - - Suppress output except warnings and errors - - - - -h, --help - - Show this help message and exit - - - - --os-auth-strategy - <auth-strategy> - - Authentication strategy (Env: OS_AUTH_STRATEGY, - default keystone). For now, any other value will disable - the authentication - - - - --os-auth-url <auth-url> - - Authentication URL (Env: OS_AUTH_URL) - - - - --os-tenant-name - <auth-tenant-name> - - Authentication tenant name (Env: OS_TENANT_NAME) - - - - - --os-tenant-id - <auth-tenant-id> - - Authentication tenant name (Env: OS_TENANT_ID) - - - - - --os-username - <auth-username> - - Authentication username (Env: OS_USERNAME) - - - - --os-password - <auth-password> - - Authentication password (Env: OS_PASSWORD) - - - - --os-region-name - <auth-region-name> - - Authentication region name (Env: OS_REGION_NAME) - - - - - --os-token <token> - - Defaults to env[OS_TOKEN] - - - - - --endpoint-type - <endpoint-type> - - Defaults to env[OS_ENDPOINT_TYPE] or - public URL. - - - - --os-url <url> - - Defaults to env[OS_URL] - - - - - --os-cacert - <ca-certificate> - - Specify a CA bundle file to use in verifying a TLS - (HTTPS) server certificate. Defaults to - env[OS_CACERT] - - - - - --insecure - - Explicitly allow neutron-debug 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. - - - - --config-file CONFIG_FILE - - Config file for interface driver (You may also use - l3_agent.ini) - - - -
-
- neutron-debug probe-create command - usage: neutron-debug probe-create NET - Create probe port - create port and interface, then - place it into the created network namespace. - Positional arguments - - NET ID - - ID of the network in which the probe will be - created. - - - -
-
- neutron-debug probe-list command - usage: neutron-debug probe-list - List probes. -
-
- neutron-debug probe-clear command - usage: neutron-debug probe-clear - Clear all probes. -
-
- neutron-debug probe-delete command - usage: neutron-debug probe-delete <port-id> - -Remove a probe. - - Positional arguments - - <port-id> - - ID of the probe to delete. - - - -
-
- neutron-debug probe-exec command - usage: neutron-debug probe-exec <port-id> <command> - Execute commands in the namespace of the probe -
-
- neutron-debug ping-all command - usage: neutron-debug ping-all <port-id> --timeout <number - All-in-one command to ping all fixed IPs - in a specified network. A probe creation is not needed - for this command. A new probe is created automatically. It will, - however, need to be deleted manually when it is no longer needed. - When there are multiple networks, the newly created probe will be - attached to a random network and thus the ping will take - place from within that random network. - - Positional arguments - - <port-id> - - ID of the port to use. - - - - - Optional arguments - - --timeout <timeout in - seconds> - - Optional ping timeout. - - - -
-
- neutron-debug example - usage: neutron-debug create-probe < NET_ID> - Create a probe namespace within the network identified - by NET_ID. The namespace will have the name of qprobe-<UUID - of the probe port> - For the following examples to function, the security group rules - may need to be modified to allow the SSH (TCP port 22) or ping - (ICMP) traffic into network. - usage: neutron-debug probe-exec <probe ID> "ssh <IP of instance>" - SSH to an instance within the network. - usage: neutron-debug ping-all <network ID>" - Ping all instances on this network to verify they are - responding. - usage: neutron-debug probe-exec <probe_ID> dhcping <VM_MAC address> -s <IP of DHCP server>" - Ping the DHCP server for this network using dhcping to - verify it is working. -
- diff --git a/doc/cli-reference/ch_cli_neutron_misc_commands.xml b/doc/cli-reference/ch_cli_neutron_misc_commands.xml new file mode 100644 index 0000000000..c1a008dcf1 --- /dev/null +++ b/doc/cli-reference/ch_cli_neutron_misc_commands.xml @@ -0,0 +1,669 @@ + + + + + + + + miscellaneous networking command-line client + +
+ + neutron-debug command-line client + The neutron-debug client is an extension + to the neutron command-line interface (CLI) for the OpenStack + neutron-debug tool. This chapter documents + neutron-debug version 2.3.0. + For help on a specific neutron-debug + command, enter: + $ neutron-debug COMMAND +
+ neutron-debug usage + [--os-password <auth-password>] + [--os-tenant-name <auth-tenant-name>] + [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] + [--os-region-name <region-name>] [--service-type <service-type>] + [--service-name <service-name>] + [--volume-service-name <volume-service-name>] + [--endpoint-type <endpoint-type>] + [--os-volume-api-version <volume-api-ver>] + [--os-cacert <ca-certificate>] [--retries <retries>] + <subcommand> ... + + + Subcommands + + probe-create + + + Create probe port - create port and interface within a network namespace. + + + + + probe-list + + + List all probes. + + + + + probe-clear + + + Clear all probes. + + + + + probe-delete + + + Delete probe - delete port then delete the namespace. + + + + + probe-exec + + + Execute commands in the namespace of the probe. + + + + + ping-all + + + ping-all is an all-in-one command to ping all fixed IPs in a specified network. + + + + +
+
+ neutron-debug optional arguments + + + --version + + Show version number and exit. + + + + -v, --verbose, --debug + + Increase verbosity of output and show tracebacks on + errors. Can be repeated. + + + + -q, --quiet + + Suppress output except warnings and errors + + + + -h, --help + + Show this help message and exit + + + + --os-auth-strategy + <auth-strategy> + + Authentication strategy (Env: OS_AUTH_STRATEGY, + default keystone). For now, any other value will disable + the authentication + + + + --os-auth-url <auth-url> + + Authentication URL (Env: OS_AUTH_URL) + + + + --os-tenant-name + <auth-tenant-name> + + Authentication tenant name (Env: OS_TENANT_NAME) + + + + + --os-tenant-id + <auth-tenant-id> + + Authentication tenant name (Env: OS_TENANT_ID) + + + + + --os-username + <auth-username> + + Authentication username (Env: OS_USERNAME) + + + + --os-password + <auth-password> + + Authentication password (Env: OS_PASSWORD) + + + + --os-region-name + <auth-region-name> + + Authentication region name (Env: OS_REGION_NAME) + + + + + --os-token <token> + + Defaults to env[OS_TOKEN] + + + + + --endpoint-type + <endpoint-type> + + Defaults to env[OS_ENDPOINT_TYPE] or + public URL. + + + + --os-url <url> + + Defaults to env[OS_URL] + + + + + --os-cacert + <ca-certificate> + + Specify a CA bundle file to use in verifying a TLS + (HTTPS) server certificate. Defaults to + env[OS_CACERT] + + + + + --insecure + + Explicitly allow neutron-debug 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. + + + + --config-file CONFIG_FILE + + Config file for interface driver (You may also use + l3_agent.ini) + + + +
+
+ neutron-debug probe-create command + usage: neutron-debug probe-create NET + Create probe port - create port and interface, then + place it into the created network namespace. + Positional arguments + + NET ID + + ID of the network in which the probe will be + created. + + + +
+
+ neutron-debug probe-list command + usage: neutron-debug probe-list + List probes. +
+
+ neutron-debug probe-clear command + usage: neutron-debug probe-clear + Clear all probes. +
+
+ neutron-debug probe-delete command + usage: neutron-debug probe-delete <port-id> + +Remove a probe. + + Positional arguments + + <port-id> + + ID of the probe to delete. + + + +
+
+ neutron-debug probe-exec command + usage: neutron-debug probe-exec <port-id> <command> + Execute commands in the namespace of the probe +
+
+ neutron-debug ping-all command + usage: neutron-debug ping-all <port-id> --timeout <number + All-in-one command to ping all fixed IPs + in a specified network. A probe creation is not needed + for this command. A new probe is created automatically. It will, + however, need to be deleted manually when it is no longer needed. + When there are multiple networks, the newly created probe will be + attached to a random network and thus the ping will take + place from within that random network. + + Positional arguments + + <port-id> + + ID of the port to use. + + + + + Optional arguments + + --timeout <timeout in + seconds> + + Optional ping timeout. + + + +
+
+ neutron-debug example + usage: neutron-debug create-probe < NET_ID> + Create a probe namespace within the network identified + by NET_ID. The namespace will have the name of qprobe-<UUID + of the probe port> + For the following examples to function, the security group rules + may need to be modified to allow the SSH (TCP port 22) or ping + (ICMP) traffic into network. + usage: neutron-debug probe-exec <probe ID> "ssh <IP of instance>" + SSH to an instance within the network. + usage: neutron-debug ping-all <network ID>" + Ping all instances on this network to verify they are + responding. + usage: neutron-debug probe-exec <probe_ID> dhcping <VM_MAC address> -s <IP of DHCP server>" + Ping the DHCP server for this network using dhcping to + verify it is working. +
+
+
+ neutron-sanity-check command-line client + The neutron-sanity-check client is a tool + that checks various sanity about the Networking service. This chapter + documents neutron-sanity-check version 7.0.2. +
+ neutron-sanity-check usage + usage: neutron-sanity-check [-h] [--arp_header_match] [--arp_responder] + [--config-dir DIR] [--config-file PATH] [--debug] + [--dibbler_version] [--dnsmasq_version] + [--ebtables_installed] [--icmpv6_header_match] + [--iproute2_vxlan] [--keepalived_ipv6_support] + [--log-config-append PATH] + [--log-date-format DATE_FORMAT] + [--log-dir LOG_DIR] [--log-file PATH] + [--log-format FORMAT] [--noarp_header_match] + [--noarp_responder] [--nodebug] + [--nodibbler_version] [--nodnsmasq_version] + [--noebtables_installed] [--noicmpv6_header_match] + [--noiproute2_vxlan] [--nokeepalived_ipv6_support] + [--nonova_notify] [--noovs_geneve] [--noovs_patch] + [--noovs_vxlan] [--noovsdb_native] + [--noread_netns] [--nouse-syslog] + [--nouse-syslog-rfc-format] [--nova_notify] + [--noverbose] [--novf_management] [--ovs_geneve] + [--ovs_patch] [--ovs_vxlan] [--ovsdb_native] + [--read_netns] [--state_path STATE_PATH] + [--syslog-log-facility SYSLOG_LOG_FACILITY] + [--use-syslog] [--use-syslog-rfc-format] + [--verbose] [--version] [--vf_management] +
+
+ neutron-sanity-check optional arguments + + + -h, --help + + show this help message and exit + + + + --arp_header_match + + Check for ARP header match support + + + + --arp_responder + + Check for ARP responder support + + + + --config-dir DIR + + Path to a config directory to pull *.conf files from. + This file set is sorted, so as to provide a + predictable parse order if individual options are + over-ridden. The set is parsed after the file(s) + specified via previous --config-file, arguments hence + over-ridden options in the directory take precedence. + + + + --config-file PATH + + Path to a config file to use. Multiple config files + can be specified, with values in later files taking + precedence. The default files used are: None. + + + + --debug, -d + + Print debugging output (set logging level to DEBUG + instead of default INFO level). + + + + --dibbler_version + + Check minimal dibbler version + + + + --dnsmasq_version + + Check minimal dnsmasq version + + + + --ebtables_installed + + Check ebtables installation + + + + --icmpv6_header_match + + Check for ICMPv6 header match support + + + + --iproute2_vxlan + + Check for iproute2 vxlan support + + + + --keepalived_ipv6_support + + Check keepalived IPv6 support + + + + --log-config-append PATH, --log_config PATH + + The name of a logging configuration file. This file is + appended to any existing logging configuration files. + For details about logging configuration files, see the + Python logging module documentation. + + + + --log-date-format DATE_FORMAT + + Format string for %(asctime)s in log records. Default: None. + + + + --log-dir LOG_DIR, --logdir LOG_DIR + + (Optional) The base directory used for relative + --log-file paths. + + + + --log-file PATH, --logfile PATH + + (Optional) Name of log file to output to. If no + default is set, logging will go to stdout. + + + + --log-format FORMAT + + DEPRECATED. A logging.Formatter log message format + string which may use any of the available + logging.LogRecord attributes. This option is + deprecated. Please use logging_context_format_string + and logging_default_format_string instead. + + + + --noarp_header_match + + The inverse of --arp_header_match + + + + --noarp_responder + + The inverse of --arp_responder + + + + --nodebug + + The inverse of --debug + + + + --nodibbler_version + + The inverse of --dibbler_version + + + + --nodnsmasq_version + + The inverse of --dnsmasq_version + + + + --noebtables_installed + + The inverse of --ebtables_installed + + + + --noicmpv6_header_match + + The inverse of --icmpv6_header_match + + + + --noiproute2_vxlan + + The inverse of --iproute2_vxlan + + + + --nokeepalived_ipv6_support + + The inverse of --keepalived_ipv6_support + + + + --nonova_notify + + The inverse of --nova_notify + + + + --noovs_geneve + + The inverse of --ovs_geneve + + + + --noovs_patch + + The inverse of --ovs_patch + + + + --noovs_vxlan + + The inverse of --ovs_vxlan + + + + --noovsdb_native + + The inverse of --ovsdb_native + + + + --noread_netns + + The inverse of --read_netns + + + + --nouse-syslog + + The inverse of --use-syslog + + + + --nouse-syslog-rfc-format + + The inverse of --use-syslog-rfc-format + + + + --nova_notify + + Check for nova notification support + + + + --noverbose + + The inverse of --verbose + + + + --novf_management + + The inverse of --vf_management + + + + --ovs_geneve + + Check for OVS Geneve support + + + + --ovs_patch + + Check for patch port support + + + + --ovs_vxlan + + Check for OVS vxlan support + + + + --ovsdb_native + + Check ovsdb native interface support + + + + --read_netns + + Check netns permission settings + + + + --state_path STATE_PATH + + Where to store Neutron state files. This directory + must be writable by the agent. + + + + --syslog-log-facility SYSLOG_LOG_FACILITY + + Syslog facility to receive log lines. + + + + --use-syslog + + Use syslog for logging. Existing syslog format is + DEPRECATED and will be changed later to honor RFC5424. + + + + --use-syslog-rfc-format + + (Optional) Enables or disables syslog rfc5424 format + for logging. If enabled, prefixes the MSG part of the + syslog message with APP-NAME (RFC5424). The format + without the APP-NAME is deprecated in Kilo, and will + be removed in Mitaka, along with this option. + + + + --verbose, -v + + If set to false, will disable INFO logging level, + making WARNING the default. + + + + --version + + show program's version number and exit + + + + --vf_management + + Check for VF management support + + + +
+
+