.. ## WARNING ###################################### .. This file is automatically generated, do not edit .. ################################################# ====================================== Networking service command-line client ====================================== The neutron client is the command-line interface (CLI) for the Networking service API and its extensions. This chapter documents :command:`neutron` version ``4.1.0``. For help on a specific :command:`neutron` command, enter: .. code-block:: console $ neutron help COMMAND .. _neutron_command_usage: neutron usage ~~~~~~~~~~~~~ .. code-block:: console usage: neutron [--version] [-v] [-q] [-h] [-r NUM] [--os-service-type ] [--os-endpoint-type ] [--service-type ] [--endpoint-type ] [--os-auth-strategy ] [--os-cloud ] [--os-auth-url ] [--os-tenant-name | --os-project-name ] [--os-tenant-id | --os-project-id ] [--os-username ] [--os-user-id ] [--os-user-domain-id ] [--os-user-domain-name ] [--os-project-domain-id ] [--os-project-domain-name ] [--os-cert ] [--os-cacert ] [--os-key ] [--os-password ] [--os-region-name ] [--os-token ] [--http-timeout ] [--os-url ] [--insecure] .. _neutron_command_options: neutron optional arguments ~~~~~~~~~~~~~~~~~~~~~~~~~~ ``--version`` show program's version number and exit ``-v, --verbose, --debug`` Increase verbosity of output and show tracebacks on errors. You can repeat this option. ``-q, --quiet`` Suppress output except warnings and errors. ``-h, --help`` Show this help message and exit. ``-r NUM, --retries NUM`` How many times the request to the Neutron server should be retried if it fails. ``--os-service-type `` Defaults to ``env[OS_NETWORK_SERVICE_TYPE]`` or network. ``--os-endpoint-type `` Defaults to ``env[OS_ENDPOINT_TYPE]`` or public. ``--service-type `` **DEPRECATED!** Use :option:`--os-service-type`. ``--endpoint-type `` **DEPRECATED!** Use :option:`--os-endpoint-type`. ``--os-auth-strategy `` **DEPRECATED!** Only keystone is supported. ``--os-cloud `` Defaults to ``env[OS_CLOUD]``. ``--os-auth-url `` Authentication URL, defaults to ``env[OS_AUTH_URL]``. ``--os-tenant-name `` Authentication tenant name, defaults to ``env[OS_TENANT_NAME]``. ``--os-project-name `` Another way to specify tenant name. This option is mutually exclusive with :option:`--os-tenant-name`. Defaults to ``env[OS_PROJECT_NAME]``. ``--os-tenant-id `` Authentication tenant ID, defaults to ``env[OS_TENANT_ID]``. ``--os-project-id `` Another way to specify tenant ID. This option is mutually exclusive with :option:`--os-tenant-id`. Defaults to ``env[OS_PROJECT_ID]``. ``--os-username `` Authentication username, defaults to ``env[OS_USERNAME]``. ``--os-user-id `` Authentication user ID (Env: OS_USER_ID) ``--os-user-domain-id `` OpenStack user domain ID. Defaults to ``env[OS_USER_DOMAIN_ID]``. ``--os-user-domain-name `` OpenStack user domain name. Defaults to ``env[OS_USER_DOMAIN_NAME]``. ``--os-project-domain-id `` Defaults to ``env[OS_PROJECT_DOMAIN_ID]``. ``--os-project-domain-name `` Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``. ``--os-cert `` Path of certificate file to use in SSL connection. This file can optionally be prepended with the private key. Defaults to ``env[OS_CERT]``. ``--os-cacert `` Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to ``env[OS_CACERT]``. ``--os-key `` 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 ``env[OS_KEY]``. ``--os-password `` Authentication password, defaults to ``env[OS_PASSWORD]``. ``--os-region-name `` Authentication region name, defaults to ``env[OS_REGION_NAME]``. ``--os-token `` Authentication token, defaults to ``env[OS_TOKEN]``. ``--http-timeout `` Timeout in seconds to wait for an HTTP response. Defaults to ``env[OS_NETWORK_TIMEOUT]`` or None if not specified. ``--os-url `` Defaults to ``env[OS_URL]``. ``--insecure`` 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. .. _neutron_common_api_v2: neutron API v2.0 commands ~~~~~~~~~~~~~~~~~~~~~~~~~ ``address-scope-create`` Create an address scope for a given tenant. ``address-scope-delete`` Delete an address scope. ``address-scope-list`` List address scopes that belong to a given tenant. ``address-scope-show`` Show information about an address scope. ``address-scope-update`` Update an address scope. ``agent-delete`` Delete a given agent. ``agent-list`` List agents. ``agent-show`` Show information of a given agent. ``agent-update`` Updates the admin status and description for a specified agent. ``auto-allocated-topology-show`` Show the auto-allocated topology of a given tenant. ``availability-zone-list`` List availability zones. ``bash-completion`` Prints all of the commands and options for bash-completion. ``bgp-dragent-list-hosting-speaker`` List Dynamic Routing agents hosting a BGP speaker. ``bgp-dragent-speaker-add`` Add a BGP speaker to a Dynamic Routing agent. ``bgp-dragent-speaker-remove`` Removes a BGP speaker from a Dynamic Routing agent. ``bgp-peer-create`` Create a BGP Peer. ``bgp-peer-delete`` Delete a BGP peer. ``bgp-peer-list`` List BGP peers. ``bgp-peer-show`` Show information of a given BGP peer. ``bgp-peer-update`` Update BGP Peer's information. ``bgp-speaker-advertiseroute-list`` List routes advertised by a given BGP speaker. ``bgp-speaker-create`` Create a BGP Speaker. ``bgp-speaker-delete`` Delete a BGP speaker. ``bgp-speaker-list`` List BGP speakers. ``bgp-speaker-list-on-dragent`` List BGP speakers hosted by a Dynamic Routing agent. ``bgp-speaker-network-add`` Add a network to the BGP speaker. ``bgp-speaker-network-remove`` Remove a network from the BGP speaker. ``bgp-speaker-peer-add`` Add a peer to the BGP speaker. ``bgp-speaker-peer-remove`` Remove a peer from the BGP speaker. ``bgp-speaker-show`` Show information of a given BGP speaker. ``bgp-speaker-update`` Update BGP Speaker's information. ``dhcp-agent-list-hosting-net`` List DHCP agents hosting a network. ``dhcp-agent-network-add`` Add a network to a DHCP agent. ``dhcp-agent-network-remove`` Remove a network from a DHCP agent. ``ext-list`` List all extensions. ``ext-show`` Show information of a given resource. ``firewall-create`` Create a firewall. ``firewall-delete`` Delete a given firewall. ``firewall-list`` List firewalls that belong to a given tenant. ``firewall-policy-create`` Create a firewall policy. ``firewall-policy-delete`` Delete a given firewall policy. ``firewall-policy-insert-rule`` Insert a rule into a given firewall policy. ``firewall-policy-list`` List firewall policies that belong to a given tenant. ``firewall-policy-remove-rule`` Remove a rule from a given firewall policy. ``firewall-policy-show`` Show information of a given firewall policy. ``firewall-policy-update`` Update a given firewall policy. ``firewall-rule-create`` Create a firewall rule. ``firewall-rule-delete`` Delete a given firewall rule. ``firewall-rule-list`` List firewall rules that belong to a given tenant. ``firewall-rule-show`` Show information of a given firewall rule. ``firewall-rule-update`` Update a given firewall rule. ``firewall-show`` Show information of a given firewall. ``firewall-update`` Update a given firewall. ``flavor-associate`` Associate a Neutron service flavor with a flavor profile. ``flavor-create`` Create a Neutron service flavor. ``flavor-delete`` Delete a given Neutron service flavor. ``flavor-disassociate`` Disassociate a Neutron service flavor from a flavor profile. ``flavor-list`` List Neutron service flavors. ``flavor-profile-create`` Create a Neutron service flavor profile. ``flavor-profile-delete`` Delete a given Neutron service flavor profile. ``flavor-profile-list`` List Neutron service flavor profiles. ``flavor-profile-show`` Show information about a given Neutron service flavor profile. ``flavor-profile-update`` Update a given Neutron service flavor profile. ``flavor-show`` Show information about a given Neutron service flavor. ``flavor-update`` Update a Neutron service flavor. ``floatingip-associate`` Create a mapping between a floating IP and a fixed IP. ``floatingip-create`` Create a floating IP for a given tenant. ``floatingip-delete`` Delete a given floating IP. ``floatingip-disassociate`` Remove a mapping from a floating IP to a fixed IP. ``floatingip-list`` List floating IPs that belong to a given tenant. ``floatingip-show`` Show information of a given floating IP. ``gateway-device-create`` Create a network gateway device. ``gateway-device-delete`` Delete a given network gateway device. ``gateway-device-list`` List network gateway devices for a given tenant. ``gateway-device-show`` Show information for a given network gateway device. ``gateway-device-update`` Update a network gateway device. ``help`` print detailed help for another command ``ipsec-site-connection-create`` Create an IPsec site connection. ``ipsec-site-connection-delete`` Delete a given IPsec site connection. ``ipsec-site-connection-list`` List IPsec site connections that belong to a given tenant. ``ipsec-site-connection-show`` Show information of a given IPsec site connection. ``ipsec-site-connection-update`` Update a given IPsec site connection. ``l3-agent-list-hosting-router`` List L3 agents hosting a router. ``l3-agent-router-add`` Add a router to a L3 agent. ``l3-agent-router-remove`` Remove a router from a L3 agent. ``lb-agent-hosting-pool`` Get loadbalancer agent hosting a pool. ``lb-healthmonitor-associate`` Create a mapping between a health monitor and a pool. ``lb-healthmonitor-create`` Create a health monitor. ``lb-healthmonitor-delete`` Delete a given health monitor. ``lb-healthmonitor-disassociate`` Remove a mapping from a health monitor to a pool. ``lb-healthmonitor-list`` List health monitors that belong to a given tenant. ``lb-healthmonitor-show`` Show information of a given health monitor. ``lb-healthmonitor-update`` Update a given health monitor. ``lb-member-create`` Create a member. ``lb-member-delete`` Delete a given member. ``lb-member-list`` List members that belong to a given tenant. ``lb-member-show`` Show information of a given member. ``lb-member-update`` Update a given member. ``lb-pool-create`` Create a pool. ``lb-pool-delete`` Delete a given pool. ``lb-pool-list`` List pools that belong to a given tenant. ``lb-pool-list-on-agent`` List the pools on a loadbalancer agent. ``lb-pool-show`` Show information of a given pool. ``lb-pool-stats`` Retrieve stats for a given pool. ``lb-pool-update`` Update a given pool. ``lb-vip-create`` Create a vip. ``lb-vip-delete`` Delete a given vip. ``lb-vip-list`` List vips that belong to a given tenant. ``lb-vip-show`` Show information of a given vip. ``lb-vip-update`` Update a given vip. ``lbaas-agent-hosting-loadbalancer`` Get lbaas v2 agent hosting a loadbalancer. ``lbaas-healthmonitor-create`` LBaaS v2 Create a healthmonitor. ``lbaas-healthmonitor-delete`` LBaaS v2 Delete a given healthmonitor. ``lbaas-healthmonitor-list`` LBaaS v2 List healthmonitors that belong to a given tenant. ``lbaas-healthmonitor-show`` LBaaS v2 Show information of a given healthmonitor. ``lbaas-healthmonitor-update`` LBaaS v2 Update a given healthmonitor. ``lbaas-l7policy-create`` LBaaS v2 Create L7 policy. ``lbaas-l7policy-delete`` LBaaS v2 Delete a given L7 policy. ``lbaas-l7policy-list`` LBaaS v2 List L7 policies that belong to a given listener. ``lbaas-l7policy-show`` LBaaS v2 Show information of a given L7 policy. ``lbaas-l7policy-update`` LBaaS v2 Update a given L7 policy. ``lbaas-l7rule-create`` LBaaS v2 Create L7 rule. ``lbaas-l7rule-delete`` LBaaS v2 Delete a given L7 rule. ``lbaas-l7rule-list`` LBaaS v2 List L7 rules that belong to a given L7 policy. ``lbaas-l7rule-show`` LBaaS v2 Show information of a given rule. ``lbaas-l7rule-update`` LBaaS v2 Update a given L7 rule. ``lbaas-listener-create`` LBaaS v2 Create a listener. ``lbaas-listener-delete`` LBaaS v2 Delete a given listener. ``lbaas-listener-list`` LBaaS v2 List listeners that belong to a given tenant. ``lbaas-listener-show`` LBaaS v2 Show information of a given listener. ``lbaas-listener-update`` LBaaS v2 Update a given listener. ``lbaas-loadbalancer-create`` LBaaS v2 Create a loadbalancer. ``lbaas-loadbalancer-delete`` LBaaS v2 Delete a given loadbalancer. ``lbaas-loadbalancer-list`` LBaaS v2 List loadbalancers that belong to a given tenant. ``lbaas-loadbalancer-list-on-agent`` List the loadbalancers on a loadbalancer v2 agent. ``lbaas-loadbalancer-show`` LBaaS v2 Show information of a given loadbalancer. ``lbaas-loadbalancer-stats`` Retrieve stats for a given loadbalancer. ``lbaas-loadbalancer-status`` Retrieve status for a given loadbalancer. ``lbaas-loadbalancer-update`` LBaaS v2 Update a given loadbalancer. ``lbaas-member-create`` LBaaS v2 Create a member. ``lbaas-member-delete`` LBaaS v2 Delete a given member. ``lbaas-member-list`` LBaaS v2 List members that belong to a given pool. ``lbaas-member-show`` LBaaS v2 Show information of a given member. ``lbaas-member-update`` LBaaS v2 Update a given member. ``lbaas-pool-create`` LBaaS v2 Create a pool. ``lbaas-pool-delete`` LBaaS v2 Delete a given pool. ``lbaas-pool-list`` LBaaS v2 List pools that belong to a given tenant. ``lbaas-pool-show`` LBaaS v2 Show information of a given pool. ``lbaas-pool-update`` LBaaS v2 Update a given pool. ``meter-label-create`` Create a metering label for a given tenant. ``meter-label-delete`` Delete a given metering label. ``meter-label-list`` List metering labels that belong to a given tenant. ``meter-label-rule-create`` Create a metering label rule for a given label. ``meter-label-rule-delete`` Delete a given metering label. ``meter-label-rule-list`` List metering labels that belong to a given label. ``meter-label-rule-show`` Show information of a given metering label rule. ``meter-label-show`` Show information of a given metering label. ``net-create`` Create a network for a given tenant. ``net-delete`` Delete a given network. ``net-external-list`` List external networks that belong to a given tenant. ``net-gateway-connect`` Add an internal network interface to a router. ``net-gateway-create`` Create a network gateway. ``net-gateway-delete`` Delete a given network gateway. ``net-gateway-disconnect`` Remove a network from a network gateway. ``net-gateway-list`` List network gateways for a given tenant. ``net-gateway-show`` Show information of a given network gateway. ``net-gateway-update`` Update the name for a network gateway. ``net-ip-availability-list`` List IP usage of networks ``net-ip-availability-show`` Show IP usage of specific network ``net-list`` List networks that belong to a given tenant. ``net-list-on-dhcp-agent`` List the networks on a DHCP agent. ``net-show`` Show information of a given network. ``net-update`` Update network's information. ``port-create`` Create a port for a given tenant. ``port-delete`` Delete a given port. ``port-list`` List ports that belong to a given tenant. ``port-show`` Show information of a given port. ``port-update`` Update port's information. ``purge`` ``qos-available-rule-types`` List available qos rule types. ``qos-bandwidth-limit-rule-create`` Create a qos bandwidth limit rule. ``qos-bandwidth-limit-rule-delete`` Delete a given qos bandwidth limit rule. ``qos-bandwidth-limit-rule-list`` List all qos bandwidth limit rules belonging to the specified policy. ``qos-bandwidth-limit-rule-show`` Show information about the given qos bandwidth limit rule. ``qos-bandwidth-limit-rule-update`` Update the given qos bandwidth limit rule. ``qos-policy-create`` Create a qos policy. ``qos-policy-delete`` Delete a given qos policy. ``qos-policy-list`` List QoS policies that belong to a given tenant connection. ``qos-policy-show`` Show information of a given qos policy. ``qos-policy-update`` Update a given qos policy. ``queue-create`` Create a queue. ``queue-delete`` Delete a given queue. ``queue-list`` List queues that belong to a given tenant. ``queue-show`` Show information of a given queue. ``quota-delete`` Delete defined quotas of a given tenant. ``quota-list`` List quotas of all tenants who have non-default quota values. ``quota-show`` Show quotas of a given tenant. ``quota-update`` Define tenant's quotas not to use defaults. ``rbac-create`` Create a RBAC policy for a given tenant. ``rbac-delete`` Delete a RBAC policy. ``rbac-list`` List RBAC policies that belong to a given tenant. ``rbac-show`` Show information of a given RBAC policy. ``rbac-update`` Update RBAC policy for given tenant. ``router-create`` Create a router for a given tenant. ``router-delete`` Delete a given router. ``router-gateway-clear`` Remove an external network gateway from a router. ``router-gateway-set`` Set the external network gateway for a router. ``router-interface-add`` Add an internal network interface to a router. ``router-interface-delete`` Remove an internal network interface from a router. ``router-list`` List routers that belong to a given tenant. ``router-list-on-l3-agent`` List the routers on a L3 agent. ``router-port-list`` List ports that belong to a given tenant, with specified router. ``router-show`` Show information of a given router. ``router-update`` Update router's information. ``security-group-create`` Create a security group. ``security-group-delete`` Delete a given security group. ``security-group-list`` List security groups that belong to a given tenant. ``security-group-rule-create`` Create a security group rule. ``security-group-rule-delete`` Delete a given security group rule. ``security-group-rule-list`` List security group rules that belong to a given tenant. ``security-group-rule-show`` Show information of a given security group rule. ``security-group-show`` Show information of a given security group. ``security-group-update`` Update a given security group. ``service-provider-list`` List service providers. ``subnet-create`` Create a subnet for a given tenant. ``subnet-delete`` Delete a given subnet. ``subnet-list`` List subnets that belong to a given tenant. ``subnet-show`` Show information of a given subnet. ``subnet-update`` Update subnet's information. ``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. ``tag-add`` Add a tag into the resource. ``tag-remove`` Remove a tag on the resource. ``tag-replace`` Replace all tags on the resource. ``vpn-endpoint-group-create`` Create a VPN endpoint group. ``vpn-endpoint-group-delete`` Delete a given VPN endpoint group. ``vpn-endpoint-group-list`` List VPN endpoint groups that belong to a given tenant. ``vpn-endpoint-group-show`` Show a specific VPN endpoint group. ``vpn-endpoint-group-update`` Update a given VPN endpoint group. ``vpn-ikepolicy-create`` Create an IKE policy. ``vpn-ikepolicy-delete`` Delete a given IKE policy. ``vpn-ikepolicy-list`` List IKE policies that belong to a tenant. ``vpn-ikepolicy-show`` Show information of a given IKE policy. ``vpn-ikepolicy-update`` Update a given IKE policy. ``vpn-ipsecpolicy-create`` Create an IPsec policy. ``vpn-ipsecpolicy-delete`` Delete a given IPsec policy. ``vpn-ipsecpolicy-list`` List IPsec policies that belong to a given tenant connection. ``vpn-ipsecpolicy-show`` Show information of a given IPsec policy. ``vpn-ipsecpolicy-update`` Update a given IPsec policy. ``vpn-service-create`` Create a VPN service. ``vpn-service-delete`` Delete a given VPN service. ``vpn-service-list`` List VPN service configurations that belong to a given tenant. ``vpn-service-show`` Show information of a given VPN service. ``vpn-service-update`` Update a given VPN service. .. _neutron_address-scope-create: neutron address-scope-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron address-scope-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--shared] NAME IP_VERSION Create an address scope for a given tenant. **Positional arguments:** ``NAME`` Specify the name of the address scope. ``IP_VERSION`` Specify the address family of the address scope. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--shared`` Set the address scope as shared. .. _neutron_address-scope-delete: neutron address-scope-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron address-scope-delete [-h] [--request-format {json}] ADDRESS_SCOPE Delete an address scope. **Positional arguments:** ``ADDRESS_SCOPE`` ID or name of address_scope to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_address-scope-show: neutron address-scope-show ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron address-scope-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] ADDRESS_SCOPE Show information about an address scope. **Positional arguments:** ``ADDRESS_SCOPE`` ID or name of address_scope to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_address-scope-update: neutron address-scope-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron address-scope-update [-h] [--request-format {json}] [--name NAME] ADDRESS_SCOPE Update an address scope. **Positional arguments:** ``ADDRESS_SCOPE`` ID or name of address_scope to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Name of the address scope to update. .. _neutron_agent-delete: neutron agent-delete ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron agent-delete [-h] [--request-format {json}] AGENT Delete a given agent. **Positional arguments:** ``AGENT`` ID of agent to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_agent-show: neutron agent-show ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron agent-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] AGENT Show information of a given agent. **Positional arguments:** ``AGENT`` ID of agent to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_agent-update: neutron agent-update ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron agent-update [-h] [--request-format {json}] [--admin-state-down] [--description DESCRIPTION] AGENT Updates the admin status and description for a specified agent. **Positional arguments:** ``AGENT`` ID of agent to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--admin-state-down`` Set admin state up of the agent to false. ``--description DESCRIPTION`` Description for the agent. .. _neutron_bgp-dragent-list-hosting-speaker: neutron bgp-dragent-list-hosting-speaker ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-dragent-list-hosting-speaker [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] BGP_SPEAKER List Dynamic Routing agents hosting a BGP speaker. **Positional arguments:** ``BGP_SPEAKER`` ID or name of the BGP speaker. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_bgp-dragent-speaker-add: neutron bgp-dragent-speaker-add ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-dragent-speaker-add [-h] [--request-format {json}] BGP_DRAGENT_ID BGP_SPEAKER Add a BGP speaker to a Dynamic Routing agent. **Positional arguments:** ``BGP_DRAGENT_ID`` ID of the Dynamic Routing agent. ``BGP_SPEAKER`` ID or name of the BGP speaker. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_bgp-dragent-speaker-remove: neutron bgp-dragent-speaker-remove ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-dragent-speaker-remove [-h] [--request-format {json}] BGP_DRAGENT_ID BGP_SPEAKER Removes a BGP speaker from a Dynamic Routing agent. **Positional arguments:** ``BGP_DRAGENT_ID`` ID of the Dynamic Routing agent. ``BGP_SPEAKER`` ID or name of the BGP speaker. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_bgp-peer-create: neutron bgp-peer-create ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-peer-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] --peer-ip PEER_IP_ADDRESS --remote-as PEER_REMOTE_AS [--auth-type PEER_AUTH_TYPE] [--password AUTH_PASSWORD] NAME Create a BGP Peer. **Positional arguments:** ``NAME`` Name of the BGP peer to create. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--peer-ip PEER_IP_ADDRESS`` Peer IP address. ``--remote-as PEER_REMOTE_AS`` Peer AS number. (Integer in [1, 65535] is allowed.) ``--auth-type PEER_AUTH_TYPE`` Authentication algorithm. Supported algorithms: none(default), md5 ``--password AUTH_PASSWORD`` Authentication password. .. _neutron_bgp-peer-delete: neutron bgp-peer-delete ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-peer-delete [-h] [--request-format {json}] BGP_PEER Delete a BGP peer. **Positional arguments:** ``BGP_PEER`` ID or name of bgp_peer to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_bgp-peer-show: neutron bgp-peer-show ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-peer-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] BGP_PEER Show information of a given BGP peer. **Positional arguments:** ``BGP_PEER`` ID or name of bgp_peer to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_bgp-peer-update: neutron bgp-peer-update ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-peer-update [-h] [--request-format {json}] [--name NAME] [--password AUTH_PASSWORD] BGP_PEER Update BGP Peer's information. **Positional arguments:** ``BGP_PEER`` ID or name of bgp_peer to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Updated name of the BGP peer. ``--password AUTH_PASSWORD`` Updated authentication password. .. _neutron_bgp-speaker-advertiseroute-list: neutron bgp-speaker-advertiseroute-list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-speaker-advertiseroute-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] BGP_SPEAKER List routes advertised by a given BGP speaker. **Positional arguments:** ``BGP_SPEAKER`` ID or name of the BGP speaker. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_bgp-speaker-create: neutron bgp-speaker-create ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-speaker-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] --local-as LOCAL_AS [--ip-version {4,6}] [--advertise-floating-ip-host-routes {True,False}] [--advertise-tenant-networks {True,False}] NAME Create a BGP Speaker. **Positional arguments:** ``NAME`` Name of the BGP speaker to create. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--local-as LOCAL_AS`` Local AS number. (Integer in [1, 65535] is allowed.) ``--ip-version {4,6} IP`` version for the BGP speaker (default is 4). ``--advertise-floating-ip-host-routes {True,False}`` Whether to enable or disable the advertisement of floating-ip host routes by the BGP speaker. By default floating ip host routes will be advertised by the BGP speaker. ``--advertise-tenant-networks {True,False}`` Whether to enable or disable the advertisement of tenant network routes by the BGP speaker. By default tenant network routes will be advertised by the BGP speaker. .. _neutron_bgp-speaker-delete: neutron bgp-speaker-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-speaker-delete [-h] [--request-format {json}] BGP_SPEAKER Delete a BGP speaker. **Positional arguments:** ``BGP_SPEAKER`` ID or name of bgp_speaker to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_bgp-speaker-list-on-dragent: neutron bgp-speaker-list-on-dragent ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-speaker-list-on-dragent [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] BGP_DRAGENT_ID List BGP speakers hosted by a Dynamic Routing agent. **Positional arguments:** ``BGP_DRAGENT_ID`` ID of the Dynamic Routing agent. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_bgp-speaker-network-add: neutron bgp-speaker-network-add ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-speaker-network-add [-h] [--request-format {json}] BGP_SPEAKER NETWORK Add a network to the BGP speaker. **Positional arguments:** ``BGP_SPEAKER`` ID or name of the BGP speaker. ``NETWORK`` ID or name of the network to add. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_bgp-speaker-network-remove: neutron bgp-speaker-network-remove ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-speaker-network-remove [-h] [--request-format {json}] BGP_SPEAKER NETWORK Remove a network from the BGP speaker. **Positional arguments:** ``BGP_SPEAKER`` ID or name of the BGP speaker. ``NETWORK`` ID or name of the network to remove. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_bgp-speaker-peer-add: neutron bgp-speaker-peer-add ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-speaker-peer-add [-h] [--request-format {json}] BGP_SPEAKER BGP_PEER Add a peer to the BGP speaker. **Positional arguments:** ``BGP_SPEAKER`` ID or name of the BGP speaker. ``BGP_PEER`` ID or name of the BGP peer to add. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_bgp-speaker-peer-remove: neutron bgp-speaker-peer-remove ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-speaker-peer-remove [-h] [--request-format {json}] BGP_SPEAKER BGP_PEER Remove a peer from the BGP speaker. **Positional arguments:** ``BGP_SPEAKER`` ID or name of the BGP speaker. ``BGP_PEER`` ID or name of the BGP peer to remove. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_bgp-speaker-show: neutron bgp-speaker-show ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-speaker-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] BGP_SPEAKER Show information of a given BGP speaker. **Positional arguments:** ``BGP_SPEAKER`` ID or name of bgp_speaker to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_bgp-speaker-update: neutron bgp-speaker-update ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron bgp-speaker-update [-h] [--request-format {json}] [--name NAME] [--advertise-floating-ip-host-routes {True,False}] [--advertise-tenant-networks {True,False}] BGP_SPEAKER Update BGP Speaker's information. **Positional arguments:** ``BGP_SPEAKER`` ID or name of bgp_speaker to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Name of the BGP speaker to update. ``--advertise-floating-ip-host-routes {True,False}`` Whether to enable or disable the advertisement of floating-ip host routes by the BGP speaker. By default floating ip host routes will be advertised by the BGP speaker. ``--advertise-tenant-networks {True,False}`` Whether to enable or disable the advertisement of tenant network routes by the BGP speaker. By default tenant network routes will be advertised by the BGP speaker. .. _neutron_dhcp-agent-list-hosting-net: neutron dhcp-agent-list-hosting-net ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron dhcp-agent-list-hosting-net [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] NETWORK List DHCP agents hosting a network. **Positional arguments:** ``NETWORK`` Network to query. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_dhcp-agent-network-add: neutron dhcp-agent-network-add ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron dhcp-agent-network-add [-h] [--request-format {json}] DHCP_AGENT NETWORK Add a network to a DHCP agent. **Positional arguments:** ``DHCP_AGENT`` ID of the DHCP agent. ``NETWORK`` Network to add. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_dhcp-agent-network-remove: neutron dhcp-agent-network-remove ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron dhcp-agent-network-remove [-h] [--request-format {json}] DHCP_AGENT NETWORK Remove a network from a DHCP agent. **Positional arguments:** ``DHCP_AGENT`` ID of the DHCP agent. ``NETWORK`` Network to remove. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_ext-show: neutron ext-show ~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron ext-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] EXTENSION Show information of a given resource. **Positional arguments:** ``EXTENSION`` ID of extension to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_firewall-create: neutron firewall-create ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--name NAME] [--description DESCRIPTION] [--router ROUTER | --no-routers] [--admin-state-down] POLICY Create a firewall. **Positional arguments:** ``POLICY`` Firewall policy name or ID. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--name NAME`` Name for the firewall. ``--description DESCRIPTION`` Description for the firewall. ``--router ROUTER`` Firewall associated router name or ID (requires FWaaS router insertion extension, this option can be repeated) ``--no-routers`` Associate no routers with the firewall (requires FWaaS router insertion extension) ``--admin-state-down`` Set admin state up to false. .. _neutron_firewall-delete: neutron firewall-delete ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-delete [-h] [--request-format {json}] FIREWALL Delete a given firewall. **Positional arguments:** ``FIREWALL`` ID or name of firewall to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_firewall-policy-create: neutron firewall-policy-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-policy-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--shared] [--audited] [--description DESCRIPTION] [--firewall-rules FIREWALL_RULES] NAME Create a firewall policy. **Positional arguments:** ``NAME`` Name for the firewall policy. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--shared`` Create a shared policy. ``--audited`` Sets audited to True. ``--description DESCRIPTION`` Description for the firewall policy. ``--firewall-rules FIREWALL_RULES`` Ordered list of whitespace-delimited firewall rule names or IDs; e.g., :option:`--firewall-rules` "rule1 rule2" .. _neutron_firewall-policy-delete: neutron firewall-policy-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-policy-delete [-h] [--request-format {json}] FIREWALL_POLICY Delete a given firewall policy. **Positional arguments:** ``FIREWALL_POLICY`` ID or name of firewall_policy to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_firewall-policy-insert-rule: neutron firewall-policy-insert-rule ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-policy-insert-rule [-h] [--request-format {json}] [--insert-before FIREWALL_RULE] [--insert-after FIREWALL_RULE] FIREWALL_POLICY FIREWALL_RULE Insert a rule into a given firewall policy. **Positional arguments:** ``FIREWALL_POLICY`` ID or name of firewall_policy to update. ``FIREWALL_RULE`` New rule to insert. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--insert-before FIREWALL_RULE`` Insert before this rule. ``--insert-after FIREWALL_RULE`` Insert after this rule. .. _neutron_firewall-policy-remove-rule: neutron firewall-policy-remove-rule ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-policy-remove-rule [-h] [--request-format {json}] FIREWALL_POLICY FIREWALL_RULE Remove a rule from a given firewall policy. **Positional arguments:** ``FIREWALL_POLICY`` ID or name of firewall_policy to update. ``FIREWALL_RULE`` Firewall rule to remove from policy. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_firewall-policy-show: neutron firewall-policy-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-policy-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] FIREWALL_POLICY Show information of a given firewall policy. **Positional arguments:** ``FIREWALL_POLICY`` ID or name of firewall_policy to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_firewall-policy-update: neutron firewall-policy-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-policy-update [-h] [--request-format {json}] [--description DESCRIPTION] [--firewall-rules FIREWALL_RULES] [--name NAME] [--shared {True,False}] [--audited {True,False}] FIREWALL_POLICY Update a given firewall policy. **Positional arguments:** ``FIREWALL_POLICY`` ID or name of firewall_policy to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--description DESCRIPTION`` Description for the firewall policy. ``--firewall-rules FIREWALL_RULES`` Ordered list of whitespace-delimited firewall rule names or IDs; e.g., :option:`--firewall-rules` "rule1 rule2" ``--name NAME`` Name for the firewall policy. ``--shared {True,False}`` Update the sharing status of the policy. (True means shared) ``--audited {True,False}`` Update the audit status of the policy. (True means auditing is enabled) .. _neutron_firewall-rule-delete: neutron firewall-rule-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-rule-delete [-h] [--request-format {json}] FIREWALL_RULE Delete a given firewall rule. **Positional arguments:** ``FIREWALL_RULE`` ID or name of firewall_rule to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_firewall-rule-show: neutron firewall-rule-show ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-rule-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] FIREWALL_RULE Show information of a given firewall rule. **Positional arguments:** ``FIREWALL_RULE`` ID or name of firewall_rule to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_firewall-rule-update: neutron firewall-rule-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-rule-update [-h] [--request-format {json}] [--shared {True,False}] [--ip-version {4,6}] [--name NAME] [--description DESCRIPTION] [--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,reject}] FIREWALL_RULE Update a given firewall rule. **Positional arguments:** ``FIREWALL_RULE`` ID or name of firewall_rule to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--shared {True,False}`` Update the shared flag for the firewall rule. ``--ip-version {4,6}`` Update IP version for the firewall rule. ``--name NAME`` Name for the firewall rule. ``--description DESCRIPTION`` Description for the firewall rule. ``--source-ip-address SOURCE_IP_ADDRESS`` Source IP address or subnet. ``--destination-ip-address DESTINATION_IP_ADDRESS`` Destination IP address or subnet. ``--source-port SOURCE_PORT`` Source port (integer in [1, 65535] or range in a:b). ``--destination-port DESTINATION_PORT`` Destination port (integer in [1, 65535] or range in a:b). ``--enabled {True,False}`` Whether to enable or disable this rule. ``--protocol {tcp,udp,icmp,any}`` Protocol for the firewall rule. ``--action {allow,deny,reject}`` Action for the firewall rule. .. _neutron_firewall-show: neutron firewall-show ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] FIREWALL Show information of a given firewall. **Positional arguments:** ``FIREWALL`` ID or name of firewall to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_firewall-update: neutron firewall-update ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron firewall-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] [--router ROUTER | --no-routers] [--policy POLICY] [--admin-state-up {True,False}] FIREWALL Update a given firewall. **Positional arguments:** ``FIREWALL`` ID or name of firewall to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Name for the firewall. ``--description DESCRIPTION`` Description for the firewall. ``--router ROUTER`` Firewall associated router name or ID (requires FWaaS router insertion extension, this option can be repeated) ``--no-routers`` Associate no routers with the firewall (requires FWaaS router insertion extension) ``--policy POLICY`` Firewall policy name or ID. ``--admin-state-up {True,False}`` Update the admin state for the firewall(True means UP) .. _neutron_flavor-associate: neutron flavor-associate ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron flavor-associate [-h] [--request-format {json}] FLAVOR FLAVOR_PROFILE Associate a Neutron service flavor with a flavor profile. **Positional arguments:** ``FLAVOR`` Name or ID of the flavor to associate. ``FLAVOR_PROFILE`` ID of the flavor profile to be associated with the flavor. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_flavor-create: neutron flavor-create ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron flavor-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--enabled {True,False}] NAME SERVICE_TYPE Create a Neutron service flavor. **Positional arguments:** ``NAME`` Name for the flavor. ``SERVICE_TYPE`` Service type to which the flavor applies to: e.g. VPN. (See service-provider-list for loaded examples.) **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--description DESCRIPTION`` Description for the flavor. ``--enabled {True,False}`` Sets enabled flag. .. _neutron_flavor-delete: neutron flavor-delete ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron flavor-delete [-h] [--request-format {json}] FLAVOR Delete a given Neutron service flavor. **Positional arguments:** ``FLAVOR`` ID or name of flavor to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_flavor-disassociate: neutron flavor-disassociate ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron flavor-disassociate [-h] [--request-format {json}] FLAVOR FLAVOR_PROFILE Disassociate a Neutron service flavor from a flavor profile. **Positional arguments:** ``FLAVOR`` Name or ID of the flavor. ``FLAVOR_PROFILE`` ID of the flavor profile to be disassociated from the flavor. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_flavor-profile-delete: neutron flavor-profile-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron flavor-profile-delete [-h] [--request-format {json}] SERVICE_PROFILE Delete a given Neutron service flavor profile. **Positional arguments:** ``SERVICE_PROFILE`` ID or name of service_profile to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_flavor-profile-show: neutron flavor-profile-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron flavor-profile-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] SERVICE_PROFILE Show information about a given Neutron service flavor profile. **Positional arguments:** ``SERVICE_PROFILE`` ID or name of service_profile to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_flavor-profile-update: neutron flavor-profile-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron flavor-profile-update [-h] [--request-format {json}] [--description DESCRIPTION] [--driver DRIVER] [--metainfo METAINFO] [--enabled {True,False}] SERVICE_PROFILE Update a given Neutron service flavor profile. **Positional arguments:** ``SERVICE_PROFILE`` ID or name of service_profile to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--description DESCRIPTION`` Description for the flavor profile. ``--driver DRIVER`` Python module path to driver. ``--metainfo METAINFO`` Metainfo for the flavor profile. ``--enabled {True,False}`` Sets enabled flag. .. _neutron_flavor-show: neutron flavor-show ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron flavor-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] FLAVOR Show information about a given Neutron service flavor. **Positional arguments:** ``FLAVOR`` ID or name of flavor to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_flavor-update: neutron flavor-update ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron flavor-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] [--enabled {True,False}] FLAVOR Update a Neutron service flavor. **Positional arguments:** ``FLAVOR`` ID or name of flavor to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Name for the flavor. ``--description DESCRIPTION`` Description for the flavor. ``--enabled {True,False}`` Sets enabled flag. .. _neutron_floatingip-associate: neutron floatingip-associate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron floatingip-associate [-h] [--request-format {json}] [--fixed-ip-address FIXED_IP_ADDRESS] FLOATINGIP_ID PORT Create a mapping between a floating IP and a fixed IP. **Positional arguments:** ``FLOATINGIP_ID`` ID of the floating IP to associate. ``PORT`` ID or name of the port to be associated with the floating IP. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--fixed-ip-address FIXED_IP_ADDRESS`` IP address on the port (only required if port has multiple IPs). .. _neutron_floatingip-create: neutron floatingip-create ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron floatingip-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--port-id PORT_ID] [--fixed-ip-address FIXED_IP_ADDRESS] [--floating-ip-address FLOATING_IP_ADDRESS] [--subnet SUBNET_ID] [--dns-domain DNS_DOMAIN] [--dns-name DNS_NAME] FLOATING_NETWORK Create a floating IP for a given tenant. **Positional arguments:** ``FLOATING_NETWORK`` Network name or ID to allocate floating IP from. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--port-id PORT_ID`` ID of the port to be associated with the floating IP. ``--fixed-ip-address FIXED_IP_ADDRESS`` IP address on the port (only required if port has multiple IPs). ``--floating-ip-address FLOATING_IP_ADDRESS`` IP address of the floating IP ``--subnet SUBNET_ID`` Subnet ID on which you want to create the floating IP. ``--dns-domain DNS_DOMAIN`` Assign DNS domain to the floatingip (requires DNS integration extension) ``--dns-name DNS_NAME`` Assign DNS name to the floatingip (requires DNS integration extension) .. _neutron_floatingip-delete: neutron floatingip-delete ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron floatingip-delete [-h] [--request-format {json}] FLOATINGIP Delete a given floating IP. **Positional arguments:** ``FLOATINGIP`` ID of floatingip to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_floatingip-disassociate: neutron floatingip-disassociate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron floatingip-disassociate [-h] [--request-format {json}] FLOATINGIP_ID Remove a mapping from a floating IP to a fixed IP. **Positional arguments:** ``FLOATINGIP_ID`` ID of the floating IP to disassociate. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_floatingip-show: neutron floatingip-show ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron floatingip-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] FLOATINGIP Show information of a given floating IP. **Positional arguments:** ``FLOATINGIP`` ID of floatingip to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_gateway-device-create: neutron gateway-device-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron gateway-device-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}] --connector-ip CONNECTOR_IP (--client-certificate CERT_DATA | --client-certificate-file CERT_FILE) NAME Create a network gateway device. **Positional arguments:** ``NAME`` Name of network gateway device to create. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}`` Type of the transport zone connector to use for this device. Valid values are gre, stt, ipsec_gre, ipsec_stt, and bridge. Defaults to stt. ipsecgre and ipsecstt are also accepted as alternative names ``--connector-ip CONNECTOR_IP`` 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. ``--client-certificate CERT_DATA`` PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller. ``--client-certificate-file CERT_FILE`` File containing the PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller. .. _neutron_gateway-device-delete: neutron gateway-device-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron gateway-device-delete [-h] [--request-format {json}] GATEWAY_DEVICE Delete a given network gateway device. **Positional arguments:** ``GATEWAY_DEVICE`` ID or name of gateway_device to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_gateway-device-show: neutron gateway-device-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron gateway-device-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] GATEWAY_DEVICE Show information for a given network gateway device. **Positional arguments:** ``GATEWAY_DEVICE`` ID or name of gateway_device to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_gateway-device-update: neutron gateway-device-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron gateway-device-update [-h] [--request-format {json}] [--name NAME] [--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}] [--connector-ip CONNECTOR_IP] [--client-certificate CERT_DATA | --client-certificate-file CERT_FILE] GATEWAY_DEVICE Update a network gateway device. **Positional arguments:** ``GATEWAY_DEVICE`` ID or name of gateway_device to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` New name for network gateway device. ``--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}`` Type of the transport zone connector to use for this device. Valid values are gre, stt, ipsec_gre, ipsec_stt, and bridge. Defaults to stt. ipsecgre and ipsecstt are also accepted as alternative names ``--connector-ip CONNECTOR_IP`` 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. ``--client-certificate CERT_DATA`` PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller. ``--client-certificate-file CERT_FILE`` File containing the PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller. .. _neutron_ipsec-site-connection-delete: neutron ipsec-site-connection-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron ipsec-site-connection-delete [-h] [--request-format {json}] IPSEC_SITE_CONNECTION Delete a given IPsec site connection. **Positional arguments:** ``IPSEC_SITE_CONNECTION`` ID or name of IPsec site connection to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_ipsec-site-connection-show: neutron ipsec-site-connection-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron ipsec-site-connection-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] IPSEC_SITE_CONNECTION Show information of a given IPsec site connection. **Positional arguments:** ``IPSEC_SITE_CONNECTION`` ID or name of IPsec site connection to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_ipsec-site-connection-update: neutron ipsec-site-connection-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron ipsec-site-connection-update [-h] [--request-format {json}] [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT] [--local-ep-group LOCAL_EP_GROUP] [--peer-ep-group PEER_EP_GROUP] IPSEC_SITE_CONNECTION Update a given IPsec site connection. **Positional arguments:** ``IPSEC_SITE_CONNECTION`` ID or name of IPsec site connection to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--dpd`` 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. ``--local-ep-group LOCAL_EP_GROUP`` Local endpoint group ID/name with subnet(s) for IPSec connection. ``--peer-ep-group PEER_EP_GROUP`` Peer endpoint group ID/name with CIDR(s) for IPsec connection. .. _neutron_l3-agent-list-hosting-router: neutron l3-agent-list-hosting-router ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron l3-agent-list-hosting-router [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] ROUTER List L3 agents hosting a router. **Positional arguments:** ``ROUTER`` Router to query. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_l3-agent-router-add: neutron l3-agent-router-add ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron l3-agent-router-add [-h] [--request-format {json}] L3_AGENT ROUTER Add a router to a L3 agent. **Positional arguments:** ``L3_AGENT`` ID of the L3 agent. ``ROUTER`` Router to add. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_l3-agent-router-remove: neutron l3-agent-router-remove ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron l3-agent-router-remove [-h] [--request-format {json}] L3_AGENT ROUTER Remove a router from a L3 agent. **Positional arguments:** ``L3_AGENT`` ID of the L3 agent. ``ROUTER`` Router to remove. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lb-agent-hosting-pool: neutron lb-agent-hosting-pool ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-agent-hosting-pool [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] POOL 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 **Positional arguments:** ``POOL`` Pool to query. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lb-healthmonitor-associate: neutron lb-healthmonitor-associate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-healthmonitor-associate [-h] [--request-format {json}] HEALTH_MONITOR_ID POOL Create a mapping between a health monitor and a pool. **Positional arguments:** ``HEALTH_MONITOR_ID`` Health monitor to associate. ``POOL`` ID of the pool to be associated with the health monitor. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lb-healthmonitor-delete: neutron lb-healthmonitor-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-healthmonitor-delete [-h] [--request-format {json}] HEALTH_MONITOR Delete a given health monitor. **Positional arguments:** ``HEALTH_MONITOR`` ID of health_monitor to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lb-healthmonitor-disassociate: neutron lb-healthmonitor-disassociate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-healthmonitor-disassociate [-h] [--request-format {json}] HEALTH_MONITOR_ID POOL Remove a mapping from a health monitor to a pool. **Positional arguments:** ``HEALTH_MONITOR_ID`` Health monitor to associate. ``POOL`` ID of the pool to be associated with the health monitor. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lb-healthmonitor-show: neutron lb-healthmonitor-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-healthmonitor-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] HEALTH_MONITOR Show information of a given health monitor. **Positional arguments:** ``HEALTH_MONITOR`` ID of health_monitor to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lb-healthmonitor-update: neutron lb-healthmonitor-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-healthmonitor-update [-h] [--request-format {json}] HEALTH_MONITOR Update a given health monitor. **Positional arguments:** ``HEALTH_MONITOR`` ID of health_monitor to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lb-member-create: neutron lb-member-create ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-member-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--admin-state-down] [--weight WEIGHT] --address ADDRESS --protocol-port PROTOCOL_PORT POOL Create a member. **Positional arguments:** ``POOL`` Pool ID or name this vip belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--admin-state-down`` Set admin state up to false. ``--weight WEIGHT`` Weight of pool member in the pool (default:1, [0..256]). ``--address ADDRESS`` IP address of the pool member on the pool network. ``--protocol-port PROTOCOL_PORT`` Port on which the pool member listens for requests or connections. .. _neutron_lb-member-delete: neutron lb-member-delete ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-member-delete [-h] [--request-format {json}] MEMBER Delete a given member. **Positional arguments:** ``MEMBER`` ID or name of member to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lb-member-show: neutron lb-member-show ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-member-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] MEMBER Show information of a given member. **Positional arguments:** ``MEMBER`` ID of member to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lb-member-update: neutron lb-member-update ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-member-update [-h] [--request-format {json}] MEMBER Update a given member. **Positional arguments:** ``MEMBER`` ID or name of member to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lb-pool-delete: neutron lb-pool-delete ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-pool-delete [-h] [--request-format {json}] POOL Delete a given pool. **Positional arguments:** ``POOL`` ID or name of pool to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lb-pool-list-on-agent: neutron lb-pool-list-on-agent ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-pool-list-on-agent [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] LBAAS_AGENT List the pools on a loadbalancer 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}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lb-pool-show: neutron lb-pool-show ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-pool-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] POOL Show information of a given pool. **Positional arguments:** ``POOL`` ID or name of pool to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lb-pool-stats: neutron lb-pool-stats ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-pool-stats [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] POOL Retrieve stats for a given pool. **Positional arguments:** ``POOL`` ID or name of pool to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lb-pool-update: neutron lb-pool-update ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-pool-update [-h] [--request-format {json}] POOL Update a given pool. **Positional arguments:** ``POOL`` ID or name of pool to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lb-vip-create: neutron lb-vip-create ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-vip-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--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 Create a vip. **Positional arguments:** ``POOL`` Pool ID or name this vip belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--address ADDRESS`` IP address of the vip. ``--admin-state-down`` Set admin state up to false. ``--connection-limit CONNECTION_LIMIT`` The maximum number of connections per second allowed for the vip. Positive integer or -1 for unlimited (default). ``--description DESCRIPTION`` Description of the vip. ``--name NAME`` Name of the vip. ``--protocol-port PROTOCOL_PORT`` TCP port on which to listen for client traffic that is associated with the vip address. ``--protocol {TCP,HTTP,HTTPS}`` Protocol for balancing. ``--subnet-id SUBNET`` The subnet on which to allocate the vip address. .. _neutron_lb-vip-delete: neutron lb-vip-delete ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-vip-delete [-h] [--request-format {json}] VIP Delete a given vip. **Positional arguments:** ``VIP`` ID or name of vip to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lb-vip-show: neutron lb-vip-show ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-vip-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] VIP Show information of a given vip. **Positional arguments:** ``VIP`` ID or name of vip to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lb-vip-update: neutron lb-vip-update ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lb-vip-update [-h] [--request-format {json}] VIP Update a given vip. **Positional arguments:** ``VIP`` ID or name of vip to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-agent-hosting-loadbalancer: neutron lbaas-agent-hosting-loadbalancer ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-agent-hosting-loadbalancer [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-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}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-healthmonitor-delete: neutron lbaas-healthmonitor-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-healthmonitor-delete [-h] [--request-format {json}] HEALTHMONITOR LBaaS v2 Delete a given healthmonitor. **Positional arguments:** ``HEALTHMONITOR`` ID or name of healthmonitor to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-healthmonitor-show: neutron lbaas-healthmonitor-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-healthmonitor-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] HEALTHMONITOR LBaaS v2 Show information of a given healthmonitor. **Positional arguments:** ``HEALTHMONITOR`` ID or name of healthmonitor to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-healthmonitor-update: neutron lbaas-healthmonitor-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-healthmonitor-update [-h] [--request-format {json}] [--name NAME] HEALTHMONITOR LBaaS v2 Update a given healthmonitor. **Positional arguments:** ``HEALTHMONITOR`` ID or name of healthmonitor to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Updated name of the health monitor. .. _neutron_lbaas-l7policy-delete: neutron lbaas-l7policy-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-l7policy-delete [-h] [--request-format {json}] L7POLICY LBaaS v2 Delete a given L7 policy. **Positional arguments:** ``L7POLICY`` ID or name of l7policy to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-l7policy-show: neutron lbaas-l7policy-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-l7policy-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] L7POLICY LBaaS v2 Show information of a given L7 policy. **Positional arguments:** ``L7POLICY`` ID or name of l7policy to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-l7policy-update: neutron lbaas-l7policy-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-l7policy-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] [--action ACTION] [--redirect-pool REDIRECT_POOL] [--redirect-url REDIRECT_URL] [--position POSITION] [--admin-state-up {True,False}] L7POLICY LBaaS v2 Update a given L7 policy. **Positional arguments:** ``L7POLICY`` ID or name of l7policy to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Name of the policy. ``--description DESCRIPTION`` Description of the policy. ``--action ACTION`` Action type of the policy. ``--redirect-pool REDIRECT_POOL`` ID or name of the pool for REDIRECT_TO_POOL action type. ``--redirect-url REDIRECT_URL`` URL for REDIRECT_TO_URL action type. This should be a valid URL string. ``--position POSITION`` L7 policy position in ordered policies list. This must be an integer starting from 1. Not specifying the position will place the policy at the tail of existing policies list. ``--admin-state-up {True,False}`` Specify the administrative state of the policy (True meaning "Up"). .. _neutron_lbaas-l7rule-create: neutron lbaas-l7rule-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-l7rule-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] --type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE} --compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO} [--invert-compare] [--key KEY] --value VALUE [--admin-state-down] L7POLICY LBaaS v2 Create L7 rule. **Positional arguments:** ``L7POLICY`` ID or name of L7 policy this rule belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE}`` Rule type. ``--compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO}`` Rule compare type. ``--invert-compare`` Invert the compare type. ``--key KEY`` Key to compare. Relevant for HEADER and COOKIE types only. ``--value VALUE`` Value to compare. ``--admin-state-down`` Set admin state up to false .. _neutron_lbaas-l7rule-delete: neutron lbaas-l7rule-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-l7rule-delete [-h] [--request-format {json}] RULE L7POLICY LBaaS v2 Delete a given L7 rule. **Positional arguments:** ``RULE`` ID or name of rule to delete. ``L7POLICY`` ID or name of L7 policy this rule belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-l7rule-list: neutron lbaas-l7rule-list ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-l7rule-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] L7POLICY LBaaS v2 List L7 rules that belong to a given L7 policy. **Positional arguments:** ``L7POLICY`` ID or name of L7 policy this rule belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-l7rule-show: neutron lbaas-l7rule-show ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-l7rule-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] RULE L7POLICY LBaaS v2 Show information of a given rule. **Positional arguments:** ``RULE`` ID or name of rule to look up. ``L7POLICY`` ID or name of L7 policy this rule belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-l7rule-update: neutron lbaas-l7rule-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-l7rule-update [-h] [--request-format {json}] [--type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE}] [--compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO}] [--invert-compare] [--key KEY] [--value VALUE] [--admin-state-up {True,False}] RULE L7POLICY LBaaS v2 Update a given L7 rule. **Positional arguments:** ``RULE`` ID or name of rule to update. ``L7POLICY`` ID or name of L7 policy this rule belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE}`` Rule type. ``--compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO}`` Rule compare type. ``--invert-compare`` Invert the compare type. ``--key KEY`` Key to compare. Relevant for HEADER and COOKIE types only. ``--value VALUE`` Value to compare. ``--admin-state-up {True,False}`` Specify the administrative state of the rule (True meaning "Up"). .. _neutron_lbaas-listener-delete: neutron lbaas-listener-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-listener-delete [-h] [--request-format {json}] LISTENER LBaaS v2 Delete a given listener. **Positional arguments:** ``LISTENER`` ID or name of listener to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-listener-show: neutron lbaas-listener-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-listener-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] LISTENER LBaaS v2 Show information of a given listener. **Positional arguments:** ``LISTENER`` ID or name of listener to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-listener-update: neutron lbaas-listener-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-listener-update [-h] [--request-format {json}] LISTENER LBaaS v2 Update a given listener. **Positional arguments:** ``LISTENER`` ID of listener to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-loadbalancer-create: neutron lbaas-loadbalancer-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-loadbalancer-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--admin-state-down] [--name NAME] [--provider PROVIDER] [--flavor FLAVOR] [--vip-address VIP_ADDRESS] VIP_SUBNET LBaaS v2 Create a loadbalancer. **Positional arguments:** ``VIP_SUBNET`` Load balancer VIP subnet. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--description DESCRIPTION`` Description of the load balancer. ``--admin-state-down`` Set admin state up to false. ``--name NAME`` Name of the load balancer. ``--provider PROVIDER`` Provider name of load balancer service. ``--flavor FLAVOR`` ID or name of flavor. ``--vip-address VIP_ADDRESS`` VIP address for the load balancer. .. _neutron_lbaas-loadbalancer-delete: neutron lbaas-loadbalancer-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-loadbalancer-delete [-h] [--request-format {json}] LOADBALANCER LBaaS v2 Delete a given loadbalancer. **Positional arguments:** ``LOADBALANCER`` ID or name of loadbalancer to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-loadbalancer-list-on-agent: neutron lbaas-loadbalancer-list-on-agent ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-loadbalancer-list-on-agent [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-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}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-loadbalancer-show: neutron lbaas-loadbalancer-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-loadbalancer-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] LOADBALANCER LBaaS v2 Show information of a given loadbalancer. **Positional arguments:** ``LOADBALANCER`` ID or name of loadbalancer to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-loadbalancer-stats: neutron lbaas-loadbalancer-stats ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-loadbalancer-stats [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] LOADBALANCER Retrieve stats for a given loadbalancer. **Positional arguments:** ``LOADBALANCER`` ID or name of loadbalancer to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-loadbalancer-status: neutron lbaas-loadbalancer-status ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-loadbalancer-status [-h] [--request-format {json}] LOADBALANCER Retrieve status for a given loadbalancer. The only output is a formatted JSON tree, and the table format does not support this type of data. **Positional arguments:** ``LOADBALANCER`` ID or name of loadbalancer to show. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-loadbalancer-update: neutron lbaas-loadbalancer-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-loadbalancer-update [-h] [--request-format {json}] LOADBALANCER LBaaS v2 Update a given loadbalancer. **Positional arguments:** ``LOADBALANCER`` ID or name of loadbalancer to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-member-create: neutron lbaas-member-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-member-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--admin-state-down] [--weight WEIGHT] [--name NAME] --subnet SUBNET --address ADDRESS --protocol-port PROTOCOL_PORT POOL LBaaS v2 Create a member. **Positional arguments:** ``POOL`` ID or name of the pool that this member belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--admin-state-down`` Set admin state up to false ``--weight WEIGHT`` Weight of member in the pool (default:1, [0..256]). ``--name NAME`` Name of the member to be created. ``--subnet SUBNET`` Subnet ID or name for the member. ``--address ADDRESS`` IP address of the pool member in the pool. ``--protocol-port PROTOCOL_PORT`` Port on which the pool member listens for requests or connections. .. _neutron_lbaas-member-delete: neutron lbaas-member-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-member-delete [-h] [--request-format {json}] MEMBER POOL LBaaS v2 Delete a given member. **Positional arguments:** ``MEMBER`` ID or name of member to delete. ``POOL`` ID or name of the pool that this member belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-member-list: neutron lbaas-member-list ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-member-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] POOL LBaaS v2 List members that belong to a given pool. **Positional arguments:** ``POOL`` ID or name of the pool that this member belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-member-show: neutron lbaas-member-show ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-member-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] MEMBER POOL LBaaS v2 Show information of a given member. **Positional arguments:** ``MEMBER`` ID or name of member to look up. ``POOL`` ID or name of the pool that this member belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-member-update: neutron lbaas-member-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-member-update [-h] [--request-format {json}] [--admin-state-down] [--weight WEIGHT] [--name NAME] MEMBER POOL LBaaS v2 Update a given member. **Positional arguments:** ``MEMBER`` ID or name of member to update. ``POOL`` ID or name of the pool that this member belongs to **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--admin-state-down`` Set admin state up to false ``--weight WEIGHT`` Weight of member in the pool (default:1, [0..256]) ``--name NAME`` Updated name of the member. .. _neutron_lbaas-pool-delete: neutron lbaas-pool-delete ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-pool-delete [-h] [--request-format {json}] POOL LBaaS v2 Delete a given pool. **Positional arguments:** ``POOL`` ID or name of pool to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_lbaas-pool-show: neutron lbaas-pool-show ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-pool-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] POOL LBaaS v2 Show information of a given pool. **Positional arguments:** ``POOL`` ID or name of pool to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_lbaas-pool-update: neutron lbaas-pool-update ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron lbaas-pool-update [-h] [--request-format {json}] POOL LBaaS v2 Update a given pool. **Positional arguments:** ``POOL`` ID or name of pool to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_meter-label-create: neutron meter-label-create ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron meter-label-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--shared] NAME Create a metering label for a given tenant. **Positional arguments:** ``NAME`` Name of metering label to create. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--description DESCRIPTION`` Description of metering label to create. ``--shared`` Set the label as shared. .. _neutron_meter-label-delete: neutron meter-label-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron meter-label-delete [-h] [--request-format {json}] METERING_LABEL Delete a given metering label. **Positional arguments:** ``METERING_LABEL`` ID or name of metering_label to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_meter-label-rule-create: neutron meter-label-rule-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron meter-label-rule-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--direction {ingress,egress}] [--excluded] LABEL REMOTE_IP_PREFIX Create a metering label rule for a given label. **Positional arguments:** ``LABEL`` Id or Name of the label. ``REMOTE_IP_PREFIX`` CIDR to match on. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--direction {ingress,egress}`` Direction of traffic, default: ingress. ``--excluded`` Exclude this CIDR from the label, default: not excluded. .. _neutron_meter-label-rule-delete: neutron meter-label-rule-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron meter-label-rule-delete [-h] [--request-format {json}] METERING_LABEL_RULE Delete a given metering label. **Positional arguments:** ``METERING_LABEL_RULE`` ID or name of metering_label_rule to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_meter-label-rule-show: neutron meter-label-rule-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron meter-label-rule-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] METERING_LABEL_RULE Show information of a given metering label rule. **Positional arguments:** ``METERING_LABEL_RULE`` ID or name of metering_label_rule to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_meter-label-show: neutron meter-label-show ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron meter-label-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] METERING_LABEL Show information of a given metering label. **Positional arguments:** ``METERING_LABEL`` ID or name of metering_label to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_net-create: neutron net-create ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--admin-state-down] [--shared] [--provider:network_type ] [--provider:physical_network ] [--provider:segmentation_id ] [--vlan-transparent {True,False}] [--qos-policy QOS_POLICY] [--availability-zone-hint AVAILABILITY_ZONE] [--dns-domain DNS_DOMAIN] NAME Create a network for a given tenant. **Positional arguments:** ``NAME`` Name of network to create. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--admin-state-down`` Set admin state up to false. ``--shared`` Set the network as shared. ``--provider:network_type `` The physical mechanism by which the virtual network is implemented. ``--provider:physical_network `` Name of the physical network over which the virtual network is implemented. ``--provider:segmentation_id `` VLAN ID for VLAN networks or tunnel-id for GRE/VXLAN networks. ``--vlan-transparent {True,False}`` Create a vlan transparent network. ``--qos-policy QOS_POLICY`` Attach QoS policy ID or name to the resource. ``--availability-zone-hint AVAILABILITY_ZONE`` Availability Zone for the network (requires availability zone extension, this option can be repeated). ``--dns-domain DNS_DOMAIN`` Assign DNS domain to the network (requires DNS integration extension) .. _neutron_net-delete: neutron net-delete ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-delete [-h] [--request-format {json}] NETWORK Delete a given network. **Positional arguments:** ``NETWORK`` ID or name of network to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_net-gateway-connect: neutron net-gateway-connect ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-gateway-connect [-h] [--request-format {json}] [--segmentation-type SEGMENTATION_TYPE] [--segmentation-id SEGMENTATION_ID] NET-GATEWAY-ID NETWORK-ID Add an internal network interface to a router. **Positional arguments:** ``NET-GATEWAY-ID`` ID of the network gateway. ``NETWORK-ID`` ID of the internal network to connect on the gateway. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--segmentation-type SEGMENTATION_TYPE`` L2 segmentation strategy on the external side of the gateway (e.g.: VLAN, FLAT). ``--segmentation-id SEGMENTATION_ID`` Identifier for the L2 segment on the external side of the gateway. .. _neutron_net-gateway-create: neutron net-gateway-create ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-gateway-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--device id=ID,interface_name=NAME_OR_ID] NAME Create a network gateway. **Positional arguments:** ``NAME`` Name of network gateway to create. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--device`` id=ID,interface_name=NAME_OR_ID Device info for this gateway. You can repeat this option for multiple devices for HA gateways. .. _neutron_net-gateway-delete: neutron net-gateway-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-gateway-delete [-h] [--request-format {json}] NETWORK_GATEWAY Delete a given network gateway. **Positional arguments:** ``NETWORK_GATEWAY`` ID or name of network_gateway to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_net-gateway-disconnect: neutron net-gateway-disconnect ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-gateway-disconnect [-h] [--request-format {json}] [--segmentation-type SEGMENTATION_TYPE] [--segmentation-id SEGMENTATION_ID] NET-GATEWAY-ID NETWORK-ID Remove a network from a network gateway. **Positional arguments:** ``NET-GATEWAY-ID`` ID of the network gateway. ``NETWORK-ID`` ID of the internal network to connect on the gateway. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--segmentation-type SEGMENTATION_TYPE`` L2 segmentation strategy on the external side of the gateway (e.g.: VLAN, FLAT). ``--segmentation-id SEGMENTATION_ID`` Identifier for the L2 segment on the external side of the gateway. .. _neutron_net-gateway-show: neutron net-gateway-show ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-gateway-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] NETWORK_GATEWAY Show information of a given network gateway. **Positional arguments:** ``NETWORK_GATEWAY`` ID or name of network_gateway to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_net-gateway-update: neutron net-gateway-update ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-gateway-update [-h] [--request-format {json}] NETWORK_GATEWAY Update the name for a network gateway. **Positional arguments:** ``NETWORK_GATEWAY`` ID or name of network_gateway to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_net-ip-availability-show: neutron net-ip-availability-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-ip-availability-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] NETWORK Show IP usage of specific network **Positional arguments:** ``NETWORK`` ID or name of network to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_net-list-on-dhcp-agent: neutron net-list-on-dhcp-agent ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-list-on-dhcp-agent [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] [--tenant-id TENANT_ID] [--name NAME] [--admin-state-up {True,False}] [--status STATUS] [--shared {True,False}] [--router:external {True,False}] [--tags TAG] [--tags-any TAG] [--not-tags TAG] [--not-tags-any TAG] DHCP_AGENT List the networks on a DHCP agent. **Positional arguments:** ``DHCP_AGENT`` ID of the DHCP agent. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_net-show: neutron net-show ~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] NETWORK Show information of a given network. **Positional arguments:** ``NETWORK`` ID or name of network to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_net-update: neutron net-update ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron net-update [-h] [--request-format {json}] [--qos-policy QOS_POLICY | --no-qos-policy] [--dns-domain DNS_DOMAIN | --no-dns-domain] NETWORK Update network's information. **Positional arguments:** ``NETWORK`` ID or name of network to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--qos-policy QOS_POLICY`` Attach QoS policy ID or name to the resource. ``--no-qos-policy`` Detach QoS policy from the resource. ``--dns-domain DNS_DOMAIN`` Assign DNS domain to the network (requires DNS integration extension.) ``--no-dns-domain`` Unassign DNS domain from the network (requires DNS integration extension.) .. _neutron_port-create: neutron port-create ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron port-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--name NAME] [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] [--device-id DEVICE_ID] [--device-owner DEVICE_OWNER] [--admin-state-down] [--mac-address MAC_ADDRESS] [--vnic-type ] [--binding-profile BINDING_PROFILE] [--security-group SECURITY_GROUP | --no-security-groups] [--extra-dhcp-opt EXTRA_DHCP_OPTS] [--qos-policy QOS_POLICY] [--allowed-address-pair ip_address=IP_ADDR[,mac_address=MAC_ADDR] | --no-allowed-address-pairs] [--dns-name DNS_NAME] NETWORK Create a port for a given tenant. **Positional arguments:** ``NETWORK`` Network ID or name this port belongs to. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--name NAME`` Name of this port. ``--fixed-ip`` subnet_id=SUBNET,ip_address=IP_ADDR Desired IP and/or subnet for this port: subnet_id=,ip_address=. You can repeat this option. ``--device-id DEVICE_ID`` Device ID of this port. ``--device-owner DEVICE_OWNER`` Device owner of this port. ``--admin-state-down`` Set admin state up to false. ``--mac-address MAC_ADDRESS`` MAC address of this port. ``--vnic-type `` VNIC type for this port. ``--binding-profile BINDING_PROFILE`` Custom data to be passed as binding:profile. ``--security-group SECURITY_GROUP`` Security group associated with the port. You can repeat this option. ``--no-security-groups`` Associate no security groups with the port. ``--extra-dhcp-opt EXTRA_DHCP_OPTS`` Extra dhcp options to be assigned to this port: opt_na me=,opt_value=,ip_version={4, 6}. You can repeat this option. ``--qos-policy QOS_POLICY`` Attach QoS policy ID or name to the resource. ``--allowed-address-pair`` ip_address=IP_ADDR[,mac_address=MAC_ADDR] Allowed address pair associated with the port.You can repeat this option. ``--no-allowed-address-pairs`` Associate no allowed address pairs with the port. ``--dns-name DNS_NAME`` Assign DNS name to the port (requires DNS integration extension) .. _neutron_port-delete: neutron port-delete ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron port-delete [-h] [--request-format {json}] PORT Delete a given port. **Positional arguments:** ``PORT`` ID or name of port to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_port-show: neutron port-show ~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron port-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] PORT Show information of a given port. **Positional arguments:** ``PORT`` ID or name of port to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_port-update: neutron port-update ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron port-update [-h] [--request-format {json}] [--name NAME] [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] [--device-id DEVICE_ID] [--device-owner DEVICE_OWNER] [--admin-state-up {True,False}] [--security-group SECURITY_GROUP | --no-security-groups] [--extra-dhcp-opt EXTRA_DHCP_OPTS] [--qos-policy QOS_POLICY | --no-qos-policy] [--allowed-address-pair ip_address=IP_ADDR[,mac_address=MAC_ADDR] | --no-allowed-address-pairs] [--dns-name DNS_NAME | --no-dns-name] PORT Update port's information. **Positional arguments:** ``PORT`` ID or name of port to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Name of this port. ``--fixed-ip`` subnet_id=SUBNET,ip_address=IP_ADDR Desired IP and/or subnet for this port: subnet_id=,ip_address=. You can repeat this option. ``--device-id DEVICE_ID`` Device ID of this port. ``--device-owner DEVICE_OWNER`` Device owner of this port. ``--admin-state-up {True,False}`` Set admin state up for the port. ``--security-group SECURITY_GROUP`` Security group associated with the port. You can repeat this option. ``--no-security-groups`` Associate no security groups with the port. ``--extra-dhcp-opt EXTRA_DHCP_OPTS`` Extra dhcp options to be assigned to this port: opt_na me=,opt_value=,ip_version={4, 6}. You can repeat this option. ``--qos-policy QOS_POLICY`` Attach QoS policy ID or name to the resource. ``--no-qos-policy`` Detach QoS policy from the resource. ``--allowed-address-pair`` ip_address=IP_ADDR[,mac_address=MAC_ADDR] Allowed address pair associated with the port.You can repeat this option. ``--no-allowed-address-pairs`` Associate no allowed address pairs with the port. ``--dns-name DNS_NAME`` Assign DNS name to the port (requires DNS integration extension.) ``--no-dns-name`` Unassign DNS name from the port (requires DNS integration extension.) .. _neutron_purge: neutron purge ~~~~~~~~~~~~~ .. code-block:: console usage: neutron purge [-h] [--request-format {json}] TENANT **Positional arguments:** ``TENANT`` ID of Tenant owning the resources to be deleted. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_qos-bandwidth-limit-rule-create: neutron qos-bandwidth-limit-rule-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron qos-bandwidth-limit-rule-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--max-kbps MAX_KBPS] [--max-burst-kbps MAX_BURST_KBPS] QOS_POLICY Create a qos bandwidth limit rule. **Positional arguments:** ``QOS_POLICY`` ID or name of the QoS policy. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--max-kbps MAX_KBPS`` max bandwidth in kbps. ``--max-burst-kbps MAX_BURST_KBPS`` max burst bandwidth in kbps. .. _neutron_qos-bandwidth-limit-rule-delete: neutron qos-bandwidth-limit-rule-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron qos-bandwidth-limit-rule-delete [-h] [--request-format {json}] BANDWIDTH_LIMIT_RULE QOS_POLICY Delete a given qos bandwidth limit rule. **Positional arguments:** ``BANDWIDTH_LIMIT_RULE`` ID of bandwidth_limit_rule to delete. ``QOS_POLICY`` ID or name of the QoS policy. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_qos-bandwidth-limit-rule-list: neutron qos-bandwidth-limit-rule-list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron qos-bandwidth-limit-rule-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] QOS_POLICY List all qos bandwidth limit rules belonging to the specified policy. **Positional arguments:** ``QOS_POLICY`` ID or name of the QoS policy. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_qos-bandwidth-limit-rule-show: neutron qos-bandwidth-limit-rule-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron qos-bandwidth-limit-rule-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] BANDWIDTH_LIMIT_RULE QOS_POLICY Show information about the given qos bandwidth limit rule. **Positional arguments:** ``BANDWIDTH_LIMIT_RULE`` ID of bandwidth_limit_rule to look up. ``QOS_POLICY`` ID or name of the QoS policy. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_qos-bandwidth-limit-rule-update: neutron qos-bandwidth-limit-rule-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron qos-bandwidth-limit-rule-update [-h] [--request-format {json}] [--max-kbps MAX_KBPS] [--max-burst-kbps MAX_BURST_KBPS] BANDWIDTH_LIMIT_RULE QOS_POLICY Update the given qos bandwidth limit rule. **Positional arguments:** ``BANDWIDTH_LIMIT_RULE`` ID of bandwidth_limit_rule to update. ``QOS_POLICY`` ID or name of the QoS policy. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--max-kbps MAX_KBPS`` max bandwidth in kbps. ``--max-burst-kbps MAX_BURST_KBPS`` max burst bandwidth in kbps. .. _neutron_qos-policy-create: neutron qos-policy-create ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron qos-policy-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--shared] NAME Create a qos policy. **Positional arguments:** ``NAME`` Name of QoS policy to create. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--description DESCRIPTION`` Description of the QoS policy. ``--shared`` Accessible by other tenants. Set shared to True (default is False). .. _neutron_qos-policy-delete: neutron qos-policy-delete ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron qos-policy-delete [-h] [--request-format {json}] POLICY Delete a given qos policy. **Positional arguments:** ``POLICY`` ID or name of policy to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_qos-policy-show: neutron qos-policy-show ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron qos-policy-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] POLICY Show information of a given qos policy. **Positional arguments:** ``POLICY`` ID or name of policy to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_qos-policy-update: neutron qos-policy-update ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron qos-policy-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] [--shared] POLICY Update a given qos policy. **Positional arguments:** ``POLICY`` ID or name of policy to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Name of QoS policy. ``--description DESCRIPTION`` Description of the QoS policy. ``--shared`` Accessible by other tenants. Set shared to True (default is False). .. _neutron_queue-create: neutron queue-create ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron queue-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--min MIN] [--max MAX] [--qos-marking QOS_MARKING] [--default DEFAULT] [--dscp DSCP] NAME Create a queue. **Positional arguments:** ``NAME`` Name of queue. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--min MIN`` Minimum rate. ``--max MAX`` Maximum rate. ``--qos-marking QOS_MARKING`` QOS marking as untrusted or trusted. ``--default DEFAULT`` If true all created ports will be the size of this queue, if queue is not specified ``--dscp DSCP`` Differentiated Services Code Point. .. _neutron_queue-delete: neutron queue-delete ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron queue-delete [-h] [--request-format {json}] QOS_QUEUE Delete a given queue. **Positional arguments:** ``QOS_QUEUE`` ID or name of qos_queue to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_queue-show: neutron queue-show ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron queue-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] QOS_QUEUE Show information of a given queue. **Positional arguments:** ``QOS_QUEUE`` ID or name of qos_queue to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_rbac-create: neutron rbac-create ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron rbac-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] --type {qos-policy,network} [--target-tenant TARGET_TENANT] --action {access_as_external,access_as_shared} RBAC_OBJECT Create a RBAC policy for a given tenant. **Positional arguments:** ``RBAC_OBJECT`` ID or name of the RBAC object. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--type {qos-policy,network}`` Type of the object that RBAC policy affects. ``--target-tenant TARGET_TENANT`` ID of the tenant to which the RBAC policy will be enforced. ``--action {access_as_external,access_as_shared}`` Action for the RBAC policy. .. _neutron_rbac-delete: neutron rbac-delete ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron rbac-delete [-h] [--request-format {json}] RBAC_POLICY Delete a RBAC policy. **Positional arguments:** ``RBAC_POLICY`` ID of rbac_policy to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_rbac-show: neutron rbac-show ~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron rbac-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] RBAC_POLICY Show information of a given RBAC policy. **Positional arguments:** ``RBAC_POLICY`` ID of rbac_policy to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_rbac-update: neutron rbac-update ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron rbac-update [-h] [--request-format {json}] [--target-tenant TARGET_TENANT] RBAC_POLICY Update RBAC policy for given tenant. **Positional arguments:** ``RBAC_POLICY`` ID of rbac_policy to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--target-tenant TARGET_TENANT`` ID of the tenant to which the RBAC policy will be enforced. .. _neutron_router-create: neutron router-create ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron router-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--admin-state-down] [--distributed {True,False}] [--ha {True,False}] [--availability-zone-hint AVAILABILITY_ZONE] NAME Create a router for a given tenant. **Positional arguments:** ``NAME`` Name of router to create. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--admin-state-down`` Set admin state up to false. ``--distributed {True,False}`` Create a distributed router. ``--ha {True,False}`` Create a highly available router. ``--availability-zone-hint AVAILABILITY_ZONE`` Availability Zone for the router (requires availability zone extension, this option can be repeated). .. _neutron_router-delete: neutron router-delete ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron router-delete [-h] [--request-format {json}] ROUTER Delete a given router. **Positional arguments:** ``ROUTER`` ID or name of router to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_router-gateway-clear: neutron router-gateway-clear ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron router-gateway-clear [-h] [--request-format {json}] ROUTER Remove an external network gateway from a router. **Positional arguments:** ``ROUTER`` ID or name of the router. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_router-gateway-set: neutron router-gateway-set ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron router-gateway-set [-h] [--request-format {json}] [--disable-snat] [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] ROUTER EXTERNAL-NETWORK Set the external network gateway for a router. **Positional arguments:** ``ROUTER`` ID or name of the router. ``EXTERNAL-NETWORK`` ID or name of the external network for the gateway. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--disable-snat`` Disable source NAT on the router gateway. ``--fixed-ip`` subnet_id=SUBNET,ip_address=IP_ADDR Desired IP and/or subnet on external network: subnet_id=,ip_address=. You can specify both of subnet_id and ip_address or specify one of them as well. You can repeat this option. .. _neutron_router-interface-add: neutron router-interface-add ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron router-interface-add [-h] [--request-format {json}] ROUTER INTERFACE Add an internal network interface to a router. **Positional arguments:** ``ROUTER`` ID or name of the router. ``INTERFACE`` 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. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_router-interface-delete: neutron router-interface-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron router-interface-delete [-h] [--request-format {json}] ROUTER INTERFACE Remove an internal network interface from a router. **Positional arguments:** ``ROUTER`` ID or name of the router. ``INTERFACE`` 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. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_router-list-on-l3-agent: neutron router-list-on-l3-agent ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron router-list-on-l3-agent [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] L3_AGENT List the routers on a L3 agent. **Positional arguments:** ``L3_AGENT`` ID of the L3 agent to query. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_router-port-list: neutron router-port-list ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron router-port-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] ROUTER List ports that belong to a given tenant, with specified router. **Positional arguments:** ``ROUTER`` ID or name of router to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_router-show: neutron router-show ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron router-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] ROUTER Show information of a given router. **Positional arguments:** ``ROUTER`` ID or name of router to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_router-update: neutron router-update ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron router-update [-h] [--request-format {json}] [--name NAME] [--admin-state-up {True,False}] [--distributed {True,False}] [--route destination=CIDR,nexthop=IP_ADDR | --no-routes] ROUTER Update router's information. **Positional arguments:** ``ROUTER`` ID or name of router to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Name of this router. ``--admin-state-up {True,False}`` Specify the administrative state of the router (True meaning "Up") ``--distributed {True,False}`` True means this router should operate in distributed mode. ``--route`` destination=CIDR,nexthop=IP_ADDR Route to associate with the router. You can repeat this option. ``--no-routes`` Remove routes associated with the router. .. _neutron_security-group-create: neutron security-group-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron security-group-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] NAME Create a security group. **Positional arguments:** ``NAME`` Name of security group. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--description DESCRIPTION`` Description of security group. .. _neutron_security-group-delete: neutron security-group-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron security-group-delete [-h] [--request-format {json}] SECURITY_GROUP Delete a given security group. **Positional arguments:** ``SECURITY_GROUP`` ID or name of security_group to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_security-group-rule-create: neutron security-group-rule-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron security-group-rule-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--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 Create a security group rule. **Positional arguments:** ``SECURITY_GROUP`` Security group name or ID to add rule. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--direction {ingress,egress}`` Direction of traffic: ingress/egress. ``--ethertype ETHERTYPE`` IPv4/IPv6 ``--protocol PROTOCOL`` Protocol of packet. Allowed values are [icmp, icmpv6, tcp, udp] and integer representations [0-255] ``--port-range-min PORT_RANGE_MIN`` Starting port range. For ICMP it is type. ``--port-range-max PORT_RANGE_MAX`` Ending port range. For ICMP it is code. ``--remote-ip-prefix REMOTE_IP_PREFIX`` CIDR to match on. ``--remote-group-id REMOTE_GROUP`` Remote security group name or ID to apply rule. .. _neutron_security-group-rule-delete: neutron security-group-rule-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron security-group-rule-delete [-h] [--request-format {json}] SECURITY_GROUP_RULE Delete a given security group rule. **Positional arguments:** ``SECURITY_GROUP_RULE`` ID of security_group_rule to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_security-group-rule-show: neutron security-group-rule-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron security-group-rule-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] SECURITY_GROUP_RULE Show information of a given security group rule. **Positional arguments:** ``SECURITY_GROUP_RULE`` ID of security_group_rule to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_security-group-show: neutron security-group-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron security-group-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] SECURITY_GROUP Show information of a given security group. **Positional arguments:** ``SECURITY_GROUP`` ID or name of security_group to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_security-group-update: neutron security-group-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron security-group-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] SECURITY_GROUP Update a given security group. **Positional arguments:** ``SECURITY_GROUP`` ID or name of security_group to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Name of security group. ``--description DESCRIPTION`` Description of security group. .. _neutron_subnet-create: neutron subnet-create ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron subnet-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--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] [--ip-version {4,6}] [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--subnetpool SUBNETPOOL] [--use-default-subnetpool] [--prefixlen PREFIX_LENGTH] NETWORK [CIDR] Create a subnet for a given tenant. **Positional arguments:** ``NETWORK`` Network ID or name this subnet belongs to. ``CIDR`` CIDR of subnet to create. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--name NAME`` Name of this subnet. ``--gateway GATEWAY_IP`` Gateway IP of this subnet. ``--no-gateway`` No distribution of gateway. ``--allocation-pool`` start=IP_ADDR,end=IP_ADDR Allocation pool IP addresses for this subnet (This option can be repeated). ``--host-route`` destination=CIDR,nexthop=IP_ADDR Additional route (This option can be repeated). ``--dns-nameserver DNS_NAMESERVER`` DNS name server for this subnet (This option can be repeated). ``--disable-dhcp`` Disable DHCP for this subnet. ``--enable-dhcp`` Enable DHCP for this subnet. ``--ip-version {4,6} IP`` version to use, default is 4. Note that when subnetpool is specified, IP version is determined from the subnetpool and this option is ignored. ``--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}`` IPv6 RA (Router Advertisement) mode. ``--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}`` IPv6 address mode. ``--subnetpool SUBNETPOOL`` ID or name of subnetpool from which this subnet will obtain a CIDR. ``--use-default-subnetpool`` Use default subnetpool for ip_version, if it exists. ``--prefixlen PREFIX_LENGTH`` Prefix length for subnet allocation from subnetpool. .. _neutron_subnet-delete: neutron subnet-delete ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron subnet-delete [-h] [--request-format {json}] SUBNET Delete a given subnet. **Positional arguments:** ``SUBNET`` ID or name of subnet to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_subnet-show: neutron subnet-show ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron subnet-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] SUBNET Show information of a given subnet. **Positional arguments:** ``SUBNET`` ID or name of subnet to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_subnet-update: neutron subnet-update ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron subnet-update [-h] [--request-format {json}] [--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] SUBNET Update subnet's information. **Positional arguments:** ``SUBNET`` ID or name of subnet to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Name of this subnet. ``--gateway GATEWAY_IP`` Gateway IP of this subnet. ``--no-gateway`` No distribution of gateway. ``--allocation-pool`` start=IP_ADDR,end=IP_ADDR Allocation pool IP addresses for this subnet (This option can be repeated). ``--host-route`` destination=CIDR,nexthop=IP_ADDR Additional route (This option can be repeated). ``--dns-nameserver DNS_NAMESERVER`` DNS name server for this subnet (This option can be repeated). ``--disable-dhcp`` Disable DHCP for this subnet. ``--enable-dhcp`` Enable DHCP for this subnet. .. _neutron_subnetpool-create: neutron subnetpool-create ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron subnetpool-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--min-prefixlen MIN_PREFIXLEN] [--max-prefixlen MAX_PREFIXLEN] [--default-prefixlen DEFAULT_PREFIXLEN] [--pool-prefix PREFIXES] [--is-default {True,False}] [--shared] [--address-scope ADDRSCOPE] 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}`` **DEPRECATED!** Only JSON request format is supported. ``--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). ``--is-default {True,False}`` Specify whether this should be the default subnetpool (True meaning default). ``--shared`` Set the subnetpool as shared. ``--address-scope ADDRSCOPE`` ID or name of the address scope with which the subnetpool is associated. Prefixes must be unique across address scopes .. _neutron_subnetpool-delete: neutron subnetpool-delete ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron subnetpool-delete [-h] [--request-format {json}] 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}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_subnetpool-show: neutron subnetpool-show ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron subnetpool-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-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}`` **DEPRECATED!** Only JSON request format is supported. ``-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: neutron subnetpool-update ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron subnetpool-update [-h] [--request-format {json}] [--min-prefixlen MIN_PREFIXLEN] [--max-prefixlen MAX_PREFIXLEN] [--default-prefixlen DEFAULT_PREFIXLEN] [--pool-prefix PREFIXES] [--is-default {True,False}] [--name NAME] [--address-scope ADDRSCOPE | --no-address-scope] 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}`` **DEPRECATED!** Only JSON request format is supported. ``--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). ``--is-default {True,False}`` Specify whether this should be the default subnetpool (True meaning default). ``--name NAME`` Name of subnetpool to update. ``--address-scope ADDRSCOPE`` ID or name of the address scope with which the subnetpool is associated. Prefixes must be unique across address scopes ``--no-address-scope`` Detach subnetpool from the address scope .. _neutron_vpn-endpoint-group-delete: neutron vpn-endpoint-group-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-endpoint-group-delete [-h] [--request-format {json}] ENDPOINT_GROUP Delete a given VPN endpoint group. **Positional arguments:** ``ENDPOINT_GROUP`` ID or name of endpoint_group to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_vpn-endpoint-group-show: neutron vpn-endpoint-group-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-endpoint-group-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] ENDPOINT_GROUP Show a specific VPN endpoint group. **Positional arguments:** ``ENDPOINT_GROUP`` ID or name of endpoint_group to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_vpn-endpoint-group-update: neutron vpn-endpoint-group-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-endpoint-group-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] ENDPOINT_GROUP Update a given VPN endpoint group. **Positional arguments:** ``ENDPOINT_GROUP`` ID or name of endpoint_group to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--name NAME`` Set a name for the endpoint group. ``--description DESCRIPTION`` Set a description for the endpoint group. .. _neutron_vpn-ikepolicy-create: neutron vpn-ikepolicy-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-ikepolicy-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--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 Create an IKE policy. **Positional arguments:** ``NAME`` Name of the IKE policy. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--description DESCRIPTION`` Description of the IKE policy ``--auth-algorithm {sha1}`` Authentication algorithm in lowercase. Default:sha1 ``--encryption-algorithm ENCRYPTION_ALGORITHM`` Encryption algorithm in lowercase, default:aes-128 ``--phase1-negotiation-mode {main}`` IKE Phase1 negotiation mode in lowercase, default:main ``--ike-version {v1,v2}`` IKE version in lowercase, default:v1 ``--pfs {group2,group5,group14}`` Perfect Forward Secrecy in lowercase, default:group5 ``--lifetime`` units=UNITS,value=VALUE IKE lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600. .. _neutron_vpn-ikepolicy-delete: neutron vpn-ikepolicy-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-ikepolicy-delete [-h] [--request-format {json}] IKEPOLICY Delete a given IKE policy. **Positional arguments:** ``IKEPOLICY`` ID or name of IKE policy to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_vpn-ikepolicy-show: neutron vpn-ikepolicy-show ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-ikepolicy-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] IKEPOLICY Show information of a given IKE policy. **Positional arguments:** ``IKEPOLICY`` ID or name of IKE policy to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_vpn-ikepolicy-update: neutron vpn-ikepolicy-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-ikepolicy-update [-h] [--request-format {json}] [--lifetime units=UNITS,value=VALUE] IKEPOLICY Update a given IKE policy. **Positional arguments:** ``IKEPOLICY`` ID or name of IKE policy to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--lifetime`` units=UNITS,value=VALUE IKE lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600. .. _neutron_vpn-ipsecpolicy-create: neutron vpn-ipsecpolicy-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-ipsecpolicy-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--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 Create an IPsec policy. **Positional arguments:** ``NAME`` Name of the IPsec policy. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--description DESCRIPTION`` Description of the IPsec policy. ``--transform-protocol {esp,ah,ah-esp}`` Transform protocol in lowercase, default:esp ``--auth-algorithm {sha1}`` Authentication algorithm in lowercase, default:sha1 ``--encryption-algorithm ENCRYPTION_ALGORITHM`` Encryption algorithm in lowercase, default:aes-128 ``--encapsulation-mode {tunnel,transport}`` Encapsulation mode in lowercase, default:tunnel ``--pfs {group2,group5,group14}`` Perfect Forward Secrecy in lowercase, default:group5 ``--lifetime`` units=UNITS,value=VALUE IPsec lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600. .. _neutron_vpn-ipsecpolicy-delete: neutron vpn-ipsecpolicy-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-ipsecpolicy-delete [-h] [--request-format {json}] IPSECPOLICY Delete a given IPsec policy. **Positional arguments:** ``IPSECPOLICY`` ID or name of IPsec policy to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_vpn-ipsecpolicy-show: neutron vpn-ipsecpolicy-show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-ipsecpolicy-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] IPSECPOLICY Show information of a given IPsec policy. **Positional arguments:** ``IPSECPOLICY`` ID or name of IPsec policy to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_vpn-ipsecpolicy-update: neutron vpn-ipsecpolicy-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-ipsecpolicy-update [-h] [--request-format {json}] [--lifetime units=UNITS,value=VALUE] IPSECPOLICY Update a given IPsec policy. **Positional arguments:** ``IPSECPOLICY`` ID or name of IPsec policy to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--lifetime`` units=UNITS,value=VALUE IPsec lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600. .. _neutron_vpn-service-create: neutron vpn-service-create ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-service-create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--admin-state-down] [--name NAME] [--description DESCRIPTION] ROUTER [SUBNET] Create a VPN service. **Positional arguments:** ``ROUTER`` Router unique identifier for the VPN service. ``SUBNET`` [**DEPRECATED** in Mitaka] Unique identifier for the local private subnet. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``--tenant-id TENANT_ID`` The owner tenant ID. ``--admin-state-down`` Set admin state up to false. ``--name NAME`` Set a name for the VPN service. ``--description DESCRIPTION`` Set a description for the VPN service. .. _neutron_vpn-service-delete: neutron vpn-service-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-service-delete [-h] [--request-format {json}] VPNSERVICE Delete a given VPN service. **Positional arguments:** ``VPNSERVICE`` ID or name of VPN service to delete. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. .. _neutron_vpn-service-show: neutron vpn-service-show ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-service-show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] VPNSERVICE Show information of a given VPN service. **Positional arguments:** ``VPNSERVICE`` ID or name of VPN service to look up. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported. ``-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_vpn-service-update: neutron vpn-service-update ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: neutron vpn-service-update [-h] [--request-format {json}] VPNSERVICE Update a given VPN service. **Positional arguments:** ``VPNSERVICE`` ID or name of VPN service to update. **Optional arguments:** ``-h, --help`` show this help message and exit ``--request-format {json}`` **DEPRECATED!** Only JSON request format is supported.