diff --git a/doc/cli-reference/generated/ch_cli_neutron_commands.xml b/doc/cli-reference/generated/ch_cli_neutron_commands.xml index 09667c4df6..083f8f5148 100644 --- a/doc/cli-reference/generated/ch_cli_neutron_commands.xml +++ b/doc/cli-reference/generated/ch_cli_neutron_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the OpenStack Networking API and its extensions. This chapter documents neutron version - 2.3.11. + 2.4.0. For help on a specific neutron @@ -357,7 +357,7 @@ cisco-credential-create - Creates a credential. + Create a credential. @@ -365,7 +365,7 @@ cisco-credential-delete - Delete a given credential. + Delete a given credential. @@ -389,7 +389,7 @@ cisco-network-profile-create - Creates a network profile. + Create a network profile. @@ -985,6 +985,14 @@ + + lbaas-agent-hosting-loadbalancer + + + Get lbaas v2 agent hosting a loadbalancer. + + + lbaas-healthmonitor-create @@ -1089,6 +1097,14 @@ + + lbaas-loadbalancer-list-on-agent + + + List the loadbalancers on a loadbalancer v2 agent. + + + lbaas-loadbalancer-show @@ -1745,6 +1761,46 @@ + + subnetpool-create + + + Create a subnetpool for a given tenant. + + + + + subnetpool-delete + + + Delete a given subnetpool. + + + + + subnetpool-list + + + List subnetpools that belong to a given tenant. + + + + + subnetpool-show + + + Show information of a given subnetpool. + + + + + subnetpool-update + + + Update subnetpool's information. + + + vpn-ikepolicy-create @@ -2040,7 +2096,7 @@ Updates the admin status and description for a specified agent. AGENT - ID or name of agent to update. + ID of agent to update. @@ -2093,7 +2149,7 @@ Updates the admin status and description for a specified agent. [--password PASSWORD] credential_name credential_type -Creates a credential. +Create a credential. Positional arguments @@ -2316,7 +2372,7 @@ Show information of a given credential. name {vlan,overlay,multi-segment,trunk} -Creates a network profile. +Create a network profile. Positional arguments @@ -3005,7 +3061,7 @@ Show information of a given resource. [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--name NAME] [--description DESCRIPTION] [--shared] - [--admin-state-down] + [--admin-state-down] [--router ROUTER] POLICY Create a firewall. @@ -3078,6 +3134,16 @@ Create a firewall. + + --router ROUTER + + + Firewall associated router names or IDs (requires + FWaaS router insertion extension, this option can be + repeated) + + +
@@ -4012,6 +4078,7 @@ Show information of a given firewall. neutron firewall-update usage: neutron firewall-update [-h] [--request-format {json,xml}] [--policy POLICY] + [--router ROUTER | --no-routers] FIREWALL Update a given firewall. @@ -4052,6 +4119,25 @@ Update a given firewall. + + --router ROUTER + + + Firewall associated router names or IDs (requires + FWaaS router insertion extension, this option can be + repeated) + + + + + --no-routers + + + Associate no routers with the firewall (requires FWaaS + router insertion extension) + + +
@@ -5709,7 +5795,7 @@ Update a given health monitor. HEALTH_MONITOR - ID or name of health_monitor to update. + ID of health_monitor to update. @@ -6768,6 +6854,68 @@ Update a given vip. + +
+
+ neutron lbaas-agent-hosting-loadbalancer + usage: neutron lbaas-agent-hosting-loadbalancer [-h] + [-f {csv,html,json,table,yaml}] + [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--request-format {json,xml}] + [-D] [-F FIELD] + loadbalancer + +Get lbaas v2 agent hosting a loadbalancer. Deriving from ListCommand though +server will return only one agent to keep common output format for all agent +schedulers + + Positional arguments + + loadbalancer + + + LoadBalancer to query. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --request-format {json,xml} + + + The XML or JSON request format. + + + + + -D, --show-details + + + Show detailed information. + + + + + -F FIELD, --field FIELD + + + Specify the field(s) to be returned by server. You can + repeat this option. + + +
@@ -6783,7 +6931,8 @@ Update a given vip. [--http-method HTTP_METHOD] [--url-path URL_PATH] --delay DELAY --max-retries MAX_RETRIES --timeout - TIMEOUT --type {PING,TCP,HTTP,HTTPS} + TIMEOUT --type {PING,TCP,HTTP,HTTPS} + --pool POOL LBaaS v2 Create a healthmonitor. @@ -6886,6 +7035,15 @@ LBaaS v2 Create a healthmonitor. + + --pool POOL ID + + + or name of the pool that this healthmonitor will + monitor. + + +
@@ -7074,7 +7232,7 @@ LBaaS v2 Update a given healthmonitor. HEALTHMONITOR - ID or name of healthmonitor to update. + ID of healthmonitor to update. @@ -7110,8 +7268,11 @@ LBaaS v2 Update a given healthmonitor. [--admin-state-down] [--connection-limit CONNECTION_LIMIT] [--description DESCRIPTION] [--name NAME] + [--default-tls-container-id DEFAULT_TLS_CONTAINER_ID] + [--sni-container-ids SNI_CONTAINER_IDS [SNI_CONTAINER_IDS ...]] --loadbalancer LOADBALANCER --protocol - {TCP,HTTP,HTTPS} --protocol-port PORT + {TCP,HTTP,HTTPS,TERMINATED_HTTPS} + --protocol-port PORT LBaaS v2 Create a listener. @@ -7174,6 +7335,22 @@ LBaaS v2 Create a listener. + + --default-tls-container-id DEFAULT_TLS_CONTAINER_ID + + + Default TLS container ID to retrieve TLS information. + + + + + --sni-container-ids SNI_CONTAINER_IDS [SNI_CONTAINER_IDS ...] + + + List of TLS container IDs for SNI. + + + --loadbalancer LOADBALANCER @@ -7183,7 +7360,7 @@ LBaaS v2 Create a listener. - --protocol {TCP,HTTP,HTTPS} + --protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS} Protocol for the listener. @@ -7385,7 +7562,7 @@ LBaaS v2 Update a given listener. LISTENER - ID or name of listener to update. + ID of listener to update. @@ -7616,6 +7793,66 @@ LBaaS v2 List loadbalancers that belong to a given tenant. + +
+
+ neutron lbaas-loadbalancer-list-on-agent + usage: neutron lbaas-loadbalancer-list-on-agent [-h] + [-f {csv,html,json,table,yaml}] + [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--request-format {json,xml}] + [-D] [-F FIELD] + lbaas_agent + +List the loadbalancers on a loadbalancer v2 agent. + + Positional arguments + + lbaas_agent + + + ID of the loadbalancer agent to query. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --request-format {json,xml} + + + The XML or JSON request format. + + + + + -D, --show-details + + + Show detailed information. + + + + + -F FIELD, --field FIELD + + + Specify the field(s) to be returned by server. You can + repeat this option. + + +
@@ -8077,27 +8314,14 @@ LBaaS v2 Update a given member. [--request-format {json,xml}] [--tenant-id TENANT_ID] [--admin-state-down] [--description DESCRIPTION] - [--healthmonitor-id HEALTHMONITOR_ID] - [--session-persistence TYPE:VALUE] - --lb-algorithm + [--session-persistence type=TYPE[,cookie_name=COOKIE_NAME]] + [--name NAME] --lb-algorithm {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP} --listener LISTENER --protocol - {HTTP,HTTPS,TCP} - NAME + {HTTP,HTTPS,TCP} LBaaS v2 Create a pool. - Positional arguments - - NAME - - - The name of the pool. - - - - - Optional arguments -h, --help @@ -8140,19 +8364,20 @@ LBaaS v2 Create a pool. - --healthmonitor-id HEALTHMONITOR_ID + --session-persistence - ID of the health monitor to use. + type=TYPE[,cookie_name=COOKIE_NAME] + The type of session persistence to use and associated + cookie name - --session-persistence + --name NAME - TYPE:VALUE - The type of session persistence to use. + The name of the pool. @@ -9375,6 +9600,7 @@ Update packet filter's information. [--provider:network_type <network_type>] [--provider:physical_network <physical_network_name>] [--provider:segmentation_id <segmentation_id>] + [--vlan-transparent {True,False}] NAME Create a network for a given tenant. @@ -9467,6 +9693,14 @@ Create a network for a given tenant. + + --vlan-transparent {True,False} + + + Create a vlan transparent network. + + +
@@ -10407,6 +10641,7 @@ Show information of a given netpartition. [--device-id DEVICE_ID] [--device-owner DEVICE_OWNER] [--admin-state-down] [--mac-address MAC_ADDRESS] + [--vnic-type <direct | macvtap | normal>] [--security-group SECURITY_GROUP | --no-security-groups] [--extra-dhcp-opt EXTRA_DHCP_OPTS] NETWORK @@ -10500,6 +10735,14 @@ Create a port for a given tenant. + + --vnic-type <direct | macvtap | normal> + + + VNIC type for this port. + + + --security-group SECURITY_GROUP @@ -12551,7 +12794,7 @@ List service providers. [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--request-format {json,xml}] [--tenant-id TENANT_ID] [--name NAME] - [--gateway GATEWAY_IP] [--no-gateway] + [--gateway GATEWAY_IP | --no-gateway] [--allocation-pool start=IP_ADDR,end=IP_ADDR] [--host-route destination=CIDR,nexthop=IP_ADDR] [--dns-nameserver DNS_NAMESERVER] @@ -12559,7 +12802,9 @@ List service providers. [--ip-version {4,6}] [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] - NETWORK CIDR + [--subnetpool SUBNETPOOL] + [--prefixlen PREFIX_LENGTH] + NETWORK [CIDR] Create a subnet for a given tenant. @@ -12699,6 +12944,23 @@ Create a subnet for a given tenant. + + --subnetpool SUBNETPOOL + + + ID or name of subnetpool from which this subnet will + obtain a CIDR. + + + + + --prefixlen PREFIX_LENGTH + + + Prefix length for subnet allocation from subnetpool. + + +
@@ -12874,7 +13136,7 @@ Show information of a given subnet.
neutron subnet-update usage: neutron subnet-update [-h] [--request-format {json,xml}] [--name NAME] - [--gateway GATEWAY_IP] [--no-gateway] + [--gateway GATEWAY_IP | --no-gateway] [--allocation-pool start=IP_ADDR,end=IP_ADDR] [--host-route destination=CIDR,nexthop=IP_ADDR] [--dns-nameserver DNS_NAMESERVER] @@ -12979,6 +13241,350 @@ Update subnet's information. + +
+
+ neutron subnetpool-create + usage: neutron subnetpool-create [-h] [-f {html,json,shell,table,value,yaml}] + [-c COLUMN] [--max-width <integer>] + [--prefix PREFIX] + [--request-format {json,xml}] + [--tenant-id TENANT_ID] + [--min-prefixlen MIN_PREFIXLEN] + [--max-prefixlen MAX_PREFIXLEN] + [--default-prefixlen DEFAULT_PREFIXLEN] + [--pool-prefix PREFIXES] [--shared] + name + +Create a subnetpool for a given tenant. + + Positional arguments + + name + + + Name of subnetpool to create. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --request-format {json,xml} + + + The XML or JSON request format. + + + + + --tenant-id TENANT_ID + + + The owner tenant ID. + + + + + --min-prefixlen MIN_PREFIXLEN + + + Subnetpool minimum prefix length. + + + + + --max-prefixlen MAX_PREFIXLEN + + + Subnetpool maximum prefix length. + + + + + --default-prefixlen DEFAULT_PREFIXLEN + + + Subnetpool default prefix length. + + + + + --pool-prefix PREFIXES + + + Subnetpool prefixes (This option can be repeated). + + + + + --shared + + + Set the subnetpool as shared. + + + + +
+
+ neutron subnetpool-delete + usage: neutron subnetpool-delete [-h] [--request-format {json,xml}] SUBNETPOOL + +Delete a given subnetpool. + + Positional arguments + + SUBNETPOOL + + + ID or name of subnetpool to delete. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --request-format {json,xml} + + + The XML or JSON request format. + + + + +
+
+ neutron subnetpool-list + usage: neutron subnetpool-list [-h] [-f {csv,html,json,table,yaml}] + [-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}] + +List subnetpools that belong to a given tenant. + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --request-format {json,xml} + + + The XML or JSON request format. + + + + + -D, --show-details + + + Show detailed information. + + + + + -F FIELD, --field FIELD + + + Specify the field(s) to be returned by server. You can + repeat this option. + + + + + -P SIZE, --page-size SIZE + + + Specify retrieve unit of each request, then split one + request to several requests. + + + + + --sort-key FIELD + + + 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. + + + + + --sort-dir {asc,desc} + + + Sorts the list in the specified direction. You can + repeat this option. + + + + +
+
+ neutron subnetpool-show + usage: neutron subnetpool-show [-h] [-f {html,json,shell,table,value,yaml}] + [-c COLUMN] [--max-width <integer>] + [--prefix PREFIX] [--request-format {json,xml}] + [-D] [-F FIELD] + SUBNETPOOL + +Show information of a given subnetpool. + + Positional arguments + + SUBNETPOOL + + + ID or name of subnetpool to look up. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --request-format {json,xml} + + + The XML or JSON request format. + + + + + -D, --show-details + + + Show detailed information. + + + + + -F FIELD, --field FIELD + + + Specify the field(s) to be returned by server. You can + repeat this option. + + + + +
+
+ neutron subnetpool-update + usage: neutron subnetpool-update [-h] [--request-format {json,xml}] + [--min-prefixlen MIN_PREFIXLEN] + [--max-prefixlen MAX_PREFIXLEN] + [--default-prefixlen DEFAULT_PREFIXLEN] + [--pool-prefix PREFIXES] [--name NAME] + SUBNETPOOL + +Update subnetpool's information. + + Positional arguments + + SUBNETPOOL + + + ID or name of subnetpool to update. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --request-format {json,xml} + + + The XML or JSON request format. + + + + + --min-prefixlen MIN_PREFIXLEN + + + Subnetpool minimum prefix length. + + + + + --max-prefixlen MAX_PREFIXLEN + + + Subnetpool maximum prefix length. + + + + + --default-prefixlen DEFAULT_PREFIXLEN + + + Subnetpool default prefix length. + + + + + --pool-prefix PREFIXES + + + Subnetpool prefixes (This option can be repeated). + + + + + --name NAME + + + Name of subnetpool to update. + + +