Networking command-line clientThe neutron client is the command-line
interface (CLI) for the OpenStack Networking API and its extensions.
This chapter documents neutron version
3.0.0.
For help on a specific neutron
command, enter:
$neutronCOMMANDneutron usageusage: neutron [--version] [-v] [-q] [-h] [-r NUM]
[--os-service-type <os-service-type>]
[--os-endpoint-type <os-endpoint-type>]
[--service-type <service-type>]
[--endpoint-type <endpoint-type>]
[--os-auth-strategy <auth-strategy>] [--os-auth-url <auth-url>]
[--os-tenant-name <auth-tenant-name> | --os-project-name <auth-project-name>]
[--os-tenant-id <auth-tenant-id> | --os-project-id <auth-project-id>]
[--os-username <auth-username>] [--os-user-id <auth-user-id>]
[--os-user-domain-id <auth-user-domain-id>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-project-domain-id <auth-project-domain-id>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-cert <certificate>] [--os-cacert <ca-certificate>]
[--os-key <key>] [--os-password <auth-password>]
[--os-region-name <auth-region-name>] [--os-token <token>]
[--http-timeout <seconds>] [--os-url <url>] [--insecure]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 <os-service-type>
Defaults to env[OS_NETWORK_SERVICE_TYPE] or network.
--os-endpoint-type <os-endpoint-type>
Defaults to env[OS_ENDPOINT_TYPE] or publicURL.
--service-type <service-type>DEPRECATED! Use --os-service-type.
--endpoint-type <endpoint-type>DEPRECATED! Use --os-endpoint-type.
--os-auth-strategy <auth-strategy>DEPRECATED! Only keystone is supported.
--os-auth-url <auth-url>
Authentication URL, defaults to env[OS_AUTH_URL].
--os-tenant-name <auth-tenant-name>
Authentication tenant name, defaults to
env[OS_TENANT_NAME].
--os-project-name <auth-project-name>
Another way to specify tenant name. This option is
mutually exclusive with --os-tenant-name. Defaults to
env[OS_PROJECT_NAME].
--os-tenant-id <auth-tenant-id>
Authentication tenant ID, defaults to
env[OS_TENANT_ID].
--os-project-id <auth-project-id>
Another way to specify tenant ID. This option is
mutually exclusive with --os-tenant-id. Defaults to
env[OS_PROJECT_ID].
--os-username <auth-username>
Authentication username, defaults to env[OS_USERNAME].
--os-user-id <auth-user-id>
Authentication user ID (Env: OS_USER_ID)
--os-user-domain-id <auth-user-domain-id>
OpenStack user domain ID. Defaults to
env[OS_USER_DOMAIN_ID].
--os-user-domain-name <auth-user-domain-name>
OpenStack user domain name. Defaults to
env[OS_USER_DOMAIN_NAME].
--os-project-domain-id <auth-project-domain-id>
Defaults to env[OS_PROJECT_DOMAIN_ID].
--os-project-domain-name <auth-project-domain-name>
Defaults to env[OS_PROJECT_DOMAIN_NAME].
--os-cert <certificate>
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 <ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to
env[OS_CACERT].
--os-key <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 <auth-password>
Authentication password, defaults to env[OS_PASSWORD].
--os-region-name <auth-region-name>
Authentication region name, defaults to
env[OS_REGION_NAME].
--os-token <token>
Authentication token, defaults to env[OS_TOKEN].
--http-timeout <seconds>
Timeout in seconds to wait for an HTTP response.
Defaults to env[OS_NETWORK_TIMEOUT] or None if not
specified.
--os-url <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 API v2.0 commandsaddress-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.
bash-completion
Prints all of the commands and options for bash-completion.
cisco-credential-create
Create a credential.
cisco-credential-delete
Delete a given credential.
cisco-credential-list
List credentials that belong to a given tenant.
cisco-credential-show
Show information of a given credential.
cisco-network-profile-create
Create a network profile.
cisco-network-profile-delete
Delete a given network profile.
cisco-network-profile-list
List network profiles that belong to a given tenant.
cisco-network-profile-show
Show information of a given network profile.
cisco-network-profile-update
Update network profile's information.
cisco-policy-profile-list
List policy profiles that belong to a given tenant.
cisco-policy-profile-show
Show information of a given policy profile.
cisco-policy-profile-update
Update policy profile'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.
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-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-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-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.
nuage-netpartition-create
Create a netpartition for a given tenant.
nuage-netpartition-delete
Delete a given netpartition.
nuage-netpartition-list
List netpartitions that belong to a given tenant.
nuage-netpartition-show
Show information of a given netpartition.
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.
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.
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-createusage: neutron address-scope-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID] [--shared]
name
Create an address scope for a given tenant.
Positional argumentsname
Specify the name of the address scope.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--shared
Set the address scope as shared.
neutron address-scope-deleteusage: neutron address-scope-delete [-h] [--request-format {json,xml}]
ADDRESS_SCOPE
Delete an address scope.
Positional argumentsADDRESS_SCOPE
ID or name of address_scope to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron address-scope-listusage: neutron address-scope-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List address scopes that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron address-scope-showusage: neutron address-scope-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
ADDRESS_SCOPE
Show information about an address scope.
Positional argumentsADDRESS_SCOPE
ID or name of address_scope to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron address-scope-updateusage: neutron address-scope-update [-h] [--request-format {json,xml}]
[--name NAME]
ADDRESS_SCOPE
Update an address scope.
Positional argumentsADDRESS_SCOPE
ID or name of address_scope to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--name NAME
Name of the address scope to update.
neutron agent-deleteusage: neutron agent-delete [-h] [--request-format {json,xml}] AGENT
Delete a given agent.
Positional argumentsAGENT
ID of agent to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron agent-listusage: neutron agent-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[--sort-key FIELD] [--sort-dir {asc,desc}]
List agents.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
--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 agent-showusage: neutron agent-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}] [-D]
[-F FIELD]
AGENT
Show information of a given agent.
Positional argumentsAGENT
ID of agent to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron agent-updateusage: neutron agent-update [-h] [--request-format {json,xml}]
[--admin-state-down] [--description DESCRIPTION]
AGENT
Updates the admin status and description for a specified agent.
Positional argumentsAGENT
ID of agent to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--admin-state-down
Set admin state up of the agent to false.
--description DESCRIPTION
Description for the agent.
neutron cisco-credential-createusage: neutron cisco-credential-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--username USERNAME]
[--password PASSWORD]
credential_name credential_type
Create a credential.
Positional argumentscredential_name
Name/IP address for credential.
credential_type
Type of the credential.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--username USERNAME
Username for the credential.
--password PASSWORD
Password for the credential.
neutron cisco-credential-deleteusage: neutron cisco-credential-delete [-h] [--request-format {json,xml}]
CREDENTIAL
Delete a given credential.
Positional argumentsCREDENTIAL
ID of credential to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron cisco-credential-listusage: neutron cisco-credential-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD]
List credentials that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron cisco-credential-showusage: neutron cisco-credential-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
CREDENTIAL
Show information of a given credential.
Positional argumentsCREDENTIAL
ID of credential to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron cisco-network-profile-createusage: neutron cisco-network-profile-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--sub_type SUB_TYPE]
[--segment_range SEGMENT_RANGE]
[--physical_network PHYSICAL_NETWORK]
[--multicast_ip_range MULTICAST_IP_RANGE]
[--add-tenant ADD_TENANTS]
name
{vlan,overlay,multi-segment,trunk}
Create a network profile.
Positional argumentsname
Name for network profile.
{vlan,overlay,multi-segment,trunk}
Segment type.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--sub_type SUB_TYPE
Sub-type for the segment. Available sub-types for
overlay segments: native, enhanced; For trunk
segments: vlan, overlay.
--segment_range SEGMENT_RANGE
Range for the segment.
--physical_network PHYSICAL_NETWORK
Name for the physical network.
--multicast_ip_range MULTICAST_IP_RANGE
Multicast IPv4 range.
--add-tenant ADD_TENANTS
Add tenant to the network profile. You can repeat this
option.
neutron cisco-network-profile-deleteusage: neutron cisco-network-profile-delete [-h] [--request-format {json,xml}]
NETWORK_PROFILE
Delete a given network profile.
Positional argumentsNETWORK_PROFILE
ID or name of network_profile to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron cisco-network-profile-listusage: neutron cisco-network-profile-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD]
List network profiles that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron cisco-network-profile-showusage: neutron cisco-network-profile-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
NETWORK_PROFILE
Show information of a given network profile.
Positional argumentsNETWORK_PROFILE
ID or name of network_profile to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron cisco-network-profile-updateusage: neutron cisco-network-profile-update [-h] [--request-format {json,xml}]
[--remove-tenant REMOVE_TENANTS]
[--add-tenant ADD_TENANTS]
NETWORK_PROFILE
Update network profile's information.
Positional argumentsNETWORK_PROFILE
ID or name of network_profile to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--remove-tenant REMOVE_TENANTS
Remove tenant from the network profile. You can repeat
this option.
--add-tenant ADD_TENANTS
Add tenant to the network profile. You can repeat this
option.
neutron cisco-policy-profile-listusage: neutron cisco-policy-profile-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD]
List policy profiles that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron cisco-policy-profile-showusage: neutron cisco-policy-profile-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
POLICY_PROFILE
Show information of a given policy profile.
Positional argumentsPOLICY_PROFILE
ID or name of policy_profile to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron cisco-policy-profile-updateusage: neutron cisco-policy-profile-update [-h] [--request-format {json,xml}]
POLICY_PROFILE
Update policy profile's information.
Positional argumentsPOLICY_PROFILE
ID or name of policy_profile to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron dhcp-agent-list-hosting-netusage: neutron dhcp-agent-list-hosting-net [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD]
network
List DHCP agents hosting a network.
Positional argumentsnetwork
Network to query.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron dhcp-agent-network-addusage: neutron dhcp-agent-network-add [-h] [--request-format {json,xml}]
dhcp_agent network
Add a network to a DHCP agent.
Positional argumentsdhcp_agent
ID of the DHCP agent.
network
Network to add.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron dhcp-agent-network-removeusage: neutron dhcp-agent-network-remove [-h] [--request-format {json,xml}]
dhcp_agent network
Remove a network from a DHCP agent.
Positional argumentsdhcp_agent
ID of the DHCP agent.
network
Network to remove.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron ext-listusage: neutron ext-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
List all extensions.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron ext-showusage: neutron ext-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--prefix PREFIX]
[--request-format {json,xml}] [-D] [-F FIELD]
EXTENSION
Show information of a given resource.
Positional argumentsEXTENSION
ID of extension to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron firewall-createusage: neutron firewall-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--tenant-id TENANT_ID] [--name NAME]
[--description DESCRIPTION]
[--admin-state-down] [--router ROUTER]
POLICY
Create a firewall.
Positional argumentsPOLICY
Firewall policy name or ID.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--name NAME
Name for the firewall.
--description DESCRIPTION
Description for the firewall rule.
--admin-state-down
Set admin state up to false.
--router ROUTER
Firewall associated router names or IDs (requires
FWaaS router insertion extension, this option can be
repeated)
neutron firewall-deleteusage: neutron firewall-delete [-h] [--request-format {json,xml}] FIREWALL
Delete a given firewall.
Positional argumentsFIREWALL
ID or name of firewall to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron firewall-listusage: neutron firewall-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List firewalls that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron firewall-policy-createusage: neutron firewall-policy-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--description DESCRIPTION] [--shared]
[--firewall-rules FIREWALL_RULES]
[--audited]
NAME
Create a firewall policy.
Positional argumentsNAME
Name for the firewall policy.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description for the firewall policy.
--shared
Create a shared policy.
--firewall-rules FIREWALL_RULES
Ordered list of whitespace-delimited firewall rule
names or IDs; e.g., --firewall-rules "rule1 rule2"
--audited
Sets audited to True.
neutron firewall-policy-deleteusage: neutron firewall-policy-delete [-h] [--request-format {json,xml}]
FIREWALL_POLICY
Delete a given firewall policy.
Positional argumentsFIREWALL_POLICY
ID or name of firewall_policy to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron firewall-policy-insert-ruleusage: neutron firewall-policy-insert-rule [-h] [--request-format {json,xml}]
[--insert-before FIREWALL_RULE]
[--insert-after FIREWALL_RULE]
FIREWALL_POLICY FIREWALL_RULE
Insert a rule into a given firewall policy.
Positional argumentsFIREWALL_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,xml}
The XML or JSON request format.
--insert-before FIREWALL_RULE
Insert before this rule.
--insert-after FIREWALL_RULE
Insert after this rule.
neutron firewall-policy-listusage: neutron firewall-policy-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List firewall policies that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron firewall-policy-remove-ruleusage: neutron firewall-policy-remove-rule [-h] [--request-format {json,xml}]
FIREWALL_POLICY FIREWALL_RULE
Remove a rule from a given firewall policy.
Positional argumentsFIREWALL_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,xml}
The XML or JSON request format.
neutron firewall-policy-showusage: neutron firewall-policy-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
FIREWALL_POLICY
Show information of a given firewall policy.
Positional argumentsFIREWALL_POLICY
ID or name of firewall_policy to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron firewall-policy-updateusage: neutron firewall-policy-update [-h] [--request-format {json,xml}]
[--firewall-rules FIREWALL_RULES]
FIREWALL_POLICY
Update a given firewall policy.
Positional argumentsFIREWALL_POLICY
ID or name of firewall_policy to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--firewall-rules FIREWALL_RULES
Ordered list of whitespace-delimited firewall rule
names or IDs; e.g., --firewall-rules "rule1 rule2"
neutron firewall-rule-createusage: neutron firewall-rule-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID] [--name NAME]
[--description DESCRIPTION] [--shared]
[--source-ip-address SOURCE_IP_ADDRESS]
[--destination-ip-address DESTINATION_IP_ADDRESS]
[--source-port SOURCE_PORT]
[--destination-port DESTINATION_PORT]
[--enabled {True,False}] --protocol
{tcp,udp,icmp,any} --action
{allow,deny,reject}
Create a firewall rule.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--name NAME
Name for the firewall rule.
--description DESCRIPTION
Description for the firewall rule.
--shared
Set shared to True (default is False).
--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-rule-deleteusage: neutron firewall-rule-delete [-h] [--request-format {json,xml}]
FIREWALL_RULE
Delete a given firewall rule.
Positional argumentsFIREWALL_RULE
ID or name of firewall_rule to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron firewall-rule-listusage: neutron firewall-rule-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List firewall rules that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron firewall-rule-showusage: neutron firewall-rule-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
FIREWALL_RULE
Show information of a given firewall rule.
Positional argumentsFIREWALL_RULE
ID or name of firewall_rule to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron firewall-rule-updateusage: neutron firewall-rule-update [-h] [--request-format {json,xml}]
[--protocol {tcp,udp,icmp,any}]
FIREWALL_RULE
Update a given firewall rule.
Positional argumentsFIREWALL_RULE
ID or name of firewall_rule to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--protocol {tcp,udp,icmp,any}
Protocol for the firewall rule.
neutron firewall-showusage: neutron firewall-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
FIREWALL
Show information of a given firewall.
Positional argumentsFIREWALL
ID or name of firewall to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron firewall-updateusage: neutron firewall-update [-h] [--request-format {json,xml}]
[--policy POLICY]
[--router ROUTER | --no-routers]
FIREWALL
Update a given firewall.
Positional argumentsFIREWALL
ID or name of firewall to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--policy POLICY
Firewall policy name or ID.
--router ROUTER
Firewall associated router names or IDs (requires
FWaaS router insertion extension, this option can be
repeated)
--no-routers
Associate no routers with the firewall (requires FWaaS
router insertion extension)
neutron floatingip-associateusage: neutron floatingip-associate [-h] [--request-format {json,xml}]
[--fixed-ip-address FIXED_IP_ADDRESS]
FLOATINGIP_ID PORT
Create a mapping between a floating IP and a fixed IP.
Positional argumentsFLOATINGIP_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,xml}
The XML or JSON request format.
--fixed-ip-address FIXED_IP_ADDRESS
IP address on the port (only required if port has
multiple IPs).
neutron floatingip-createusage: neutron floatingip-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID] [--port-id PORT_ID]
[--fixed-ip-address FIXED_IP_ADDRESS]
[--floating-ip-address FLOATING_IP_ADDRESS]
FLOATING_NETWORK
Create a floating IP for a given tenant.
Positional argumentsFLOATING_NETWORK
Network name or ID to allocate floating IP from.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--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
neutron floatingip-deleteusage: neutron floatingip-delete [-h] [--request-format {json,xml}] FLOATINGIP
Delete a given floating IP.
Positional argumentsFLOATINGIP
ID of floatingip to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron floatingip-disassociateusage: neutron floatingip-disassociate [-h] [--request-format {json,xml}]
FLOATINGIP_ID
Remove a mapping from a floating IP to a fixed IP.
Positional argumentsFLOATINGIP_ID
ID of the floating IP to disassociate.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron floatingip-listusage: neutron floatingip-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List floating IPs that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron floatingip-showusage: neutron floatingip-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
FLOATINGIP
Show information of a given floating IP.
Positional argumentsFLOATINGIP
ID of floatingip to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron gateway-device-createusage: neutron gateway-device-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--connector-type {stt,gre,ipsecgre,ipsecstt,bridge}]
--connector-ip CONNECTOR_IP
(--client-certificate CERT_DATA | --client-certificate-file CERT_FILE)
NAME
Create a network gateway device.
Positional argumentsNAME
Name of network gateway device to create.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--connector-type {stt,gre,ipsecgre,ipsecstt,bridge}
Type of the transport zone connector to use for this
device. Valid values are gre, stt, ipsecgre, ipsecstt,
and bridge. Defaults to stt.
--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-deleteusage: neutron gateway-device-delete [-h] [--request-format {json,xml}]
GATEWAY_DEVICE
Delete a given network gateway device.
Positional argumentsGATEWAY_DEVICE
ID or name of gateway_device to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron gateway-device-listusage: neutron gateway-device-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD]
List network gateway devices for a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron gateway-device-showusage: neutron gateway-device-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
GATEWAY_DEVICE
Show information for a given network gateway device.
Positional argumentsGATEWAY_DEVICE
ID or name of gateway_device to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron gateway-device-updateusage: neutron gateway-device-update [-h] [--request-format {json,xml}]
[--name NAME]
[--connector-type {stt,gre,ipsecgre,ipsecstt,bridge}]
[--connector-ip CONNECTOR_IP]
[--client-certificate CERT_DATA | --client-certificate-file CERT_FILE]
GATEWAY_DEVICE
Update a network gateway device.
Positional argumentsGATEWAY_DEVICE
ID or name of gateway_device to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--name NAME
New name for network gateway device.
--connector-type {stt,gre,ipsecgre,ipsecstt,bridge}
Type of the transport zone connector to use for this
device. Valid values are gre, stt, ipsecgre, ipsecstt,
and bridge. Defaults to stt.
--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-createusage: neutron ipsec-site-connection-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--admin-state-down] [--name NAME]
[--description DESCRIPTION]
[--mtu MTU]
[--initiator {bi-directional,response-only}]
[--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
--vpnservice-id VPNSERVICE
--ikepolicy-id IKEPOLICY
--ipsecpolicy-id IPSECPOLICY
--peer-address PEER_ADDRESS
--peer-id PEER_ID --peer-cidr
PEER_CIDRS --psk PSK
Create an IPsec site connection.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--name NAME
Set friendly name for the connection.
--description DESCRIPTION
Set a description for the connection.
--mtu MTU
MTU size for the connection, default:1500
--initiator {bi-directional,response-only}
Initiator state in lowercase, default:bi-directional
--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.
--vpnservice-id VPNSERVICE
VPN service instance ID associated with this
connection.
--ikepolicy-id IKEPOLICY
IKE policy ID associated with this connection.
--ipsecpolicy-id IPSECPOLICY
IPsec policy ID associated with this connection.
--peer-address PEER_ADDRESS
Peer gateway public IPv4/IPv6 address or FQDN.
--peer-id PEER_ID
Peer router identity for authentication. Can be
IPv4/IPv6 address, e-mail address, key id, or FQDN.
--peer-cidr PEER_CIDRS
Remote subnet(s) in CIDR format.
--psk PSK
Pre-shared key string.
neutron ipsec-site-connection-deleteusage: neutron ipsec-site-connection-delete [-h] [--request-format {json,xml}]
IPSEC_SITE_CONNECTION
Delete a given IPsec site connection.
Positional argumentsIPSEC_SITE_CONNECTION
ID or name of ipsec_site_connection to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron ipsec-site-connection-listusage: neutron ipsec-site-connection-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE]
[--sort-key FIELD]
[--sort-dir {asc,desc}]
List IPsec site connections that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron ipsec-site-connection-showusage: neutron ipsec-site-connection-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
IPSEC_SITE_CONNECTION
Show information of a given IPsec site connection.
Positional argumentsIPSEC_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,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron ipsec-site-connection-updateusage: neutron ipsec-site-connection-update [-h] [--request-format {json,xml}]
[--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
IPSEC_SITE_CONNECTION
Update a given IPsec site connection.
Positional argumentsIPSEC_SITE_CONNECTION
ID or name of ipsec_site_connection to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--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.
neutron l3-agent-list-hosting-routerusage: neutron l3-agent-list-hosting-router [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD]
router
List L3 agents hosting a router.
Positional argumentsrouter
Router to query.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron l3-agent-router-addusage: neutron l3-agent-router-add [-h] [--request-format {json,xml}]
l3_agent router
Add a router to a L3 agent.
Positional argumentsl3_agent
ID of the L3 agent.
router
Router to add.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron l3-agent-router-removeusage: neutron l3-agent-router-remove [-h] [--request-format {json,xml}]
l3_agent router
Remove a router from a L3 agent.
Positional argumentsl3_agent
ID of the L3 agent.
router
Router to remove.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lb-agent-hosting-poolusage: neutron lb-agent-hosting-pool [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-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 argumentspool
Pool to query.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lb-healthmonitor-associateusage: neutron lb-healthmonitor-associate [-h] [--request-format {json,xml}]
HEALTH_MONITOR_ID POOL
Create a mapping between a health monitor and a pool.
Positional argumentsHEALTH_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,xml}
The XML or JSON request format.
neutron lb-healthmonitor-createusage: neutron lb-healthmonitor-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--admin-state-down]
[--expected-codes EXPECTED_CODES]
[--http-method HTTP_METHOD]
[--url-path URL_PATH] --delay DELAY
--max-retries MAX_RETRIES --timeout
TIMEOUT --type {PING,TCP,HTTP,HTTPS}
Create a health monitor.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--expected-codes EXPECTED_CODES
The list of HTTP status codes expected in response
from the member to declare it healthy. This attribute
can contain one value, or a list of values separated
by comma, or a range of values (e.g. "200-299"). If
this attribute is not specified, it defaults to "200".
--http-method HTTP_METHOD
The HTTP method used for requests by the monitor of
type HTTP.
--url-path URL_PATH
The HTTP path used in the HTTP request used by the
monitor to test a member health. This must be a string
beginning with a / (forward slash).
--delay DELAY
The time in seconds between sending probes to members.
--max-retries MAX_RETRIES
Number of permissible connection failures before
changing the member status to INACTIVE. [1..10]
--timeout TIMEOUT
Maximum number of seconds for a monitor to wait for a
connection to be established before it times out. The
value must be less than the delay value.
--type {PING,TCP,HTTP,HTTPS}
One of the predefined health monitor types.
neutron lb-healthmonitor-deleteusage: neutron lb-healthmonitor-delete [-h] [--request-format {json,xml}]
HEALTH_MONITOR
Delete a given health monitor.
Positional argumentsHEALTH_MONITOR
ID of health_monitor to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lb-healthmonitor-disassociateusage: neutron lb-healthmonitor-disassociate [-h]
[--request-format {json,xml}]
HEALTH_MONITOR_ID POOL
Remove a mapping from a health monitor to a pool.
Positional argumentsHEALTH_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,xml}
The XML or JSON request format.
neutron lb-healthmonitor-listusage: neutron lb-healthmonitor-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List health monitors that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron lb-healthmonitor-showusage: neutron lb-healthmonitor-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
HEALTH_MONITOR
Show information of a given health monitor.
Positional argumentsHEALTH_MONITOR
ID of health_monitor to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lb-healthmonitor-updateusage: neutron lb-healthmonitor-update [-h] [--request-format {json,xml}]
HEALTH_MONITOR
Update a given health monitor.
Positional argumentsHEALTH_MONITOR
ID of health_monitor to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lb-member-createusage: neutron lb-member-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID] [--admin-state-down]
[--weight WEIGHT] --address ADDRESS
--protocol-port PROTOCOL_PORT
POOL
Create a member.
Positional argumentsPOOL
Pool ID or name this vip belongs to.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--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-deleteusage: neutron lb-member-delete [-h] [--request-format {json,xml}] MEMBER
Delete a given member.
Positional argumentsMEMBER
ID or name of member to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lb-member-listusage: neutron lb-member-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List members that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron lb-member-showusage: neutron lb-member-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
MEMBER
Show information of a given member.
Positional argumentsMEMBER
ID of member to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lb-member-updateusage: neutron lb-member-update [-h] [--request-format {json,xml}] MEMBER
Update a given member.
Positional argumentsMEMBER
ID or name of member to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lb-pool-createusage: neutron lb-pool-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--tenant-id TENANT_ID] [--admin-state-down]
[--description DESCRIPTION] --lb-method
{ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP} --name
NAME --protocol {HTTP,HTTPS,TCP} --subnet-id
SUBNET [--provider PROVIDER]
Create a pool.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--description DESCRIPTION
Description of the pool.
--lb-method {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}
The algorithm used to distribute load between the
members of the pool.
--name NAME
The name of the pool.
--protocol {HTTP,HTTPS,TCP}
Protocol for balancing.
--subnet-id SUBNET
The subnet on which the members of the pool will be
located.
--provider PROVIDER
Provider name of loadbalancer service.
neutron lb-pool-deleteusage: neutron lb-pool-delete [-h] [--request-format {json,xml}] POOL
Delete a given pool.
Positional argumentsPOOL
ID or name of pool to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lb-pool-listusage: neutron lb-pool-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List pools that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron lb-pool-list-on-agentusage: neutron lb-pool-list-on-agent [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD]
lbaas_agent
List the pools on a loadbalancer agent.
Positional argumentslbaas_agent
ID of the loadbalancer agent to query.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lb-pool-showusage: neutron lb-pool-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
POOL
Show information of a given pool.
Positional argumentsPOOL
ID or name of pool to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lb-pool-statsusage: neutron lb-pool-stats [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
POOL
Retrieve stats for a given pool.
Positional argumentsPOOL
ID or name of pool to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lb-pool-updateusage: neutron lb-pool-update [-h] [--request-format {json,xml}] POOL
Update a given pool.
Positional argumentsPOOL
ID or name of pool to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lb-vip-createusage: neutron lb-vip-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--tenant-id TENANT_ID] [--address ADDRESS]
[--admin-state-down]
[--connection-limit CONNECTION_LIMIT]
[--description DESCRIPTION] --name NAME
--protocol-port PROTOCOL_PORT --protocol
{TCP,HTTP,HTTPS} --subnet-id SUBNET
POOL
Create a vip.
Positional argumentsPOOL
Pool ID or name this vip belongs to.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--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-deleteusage: neutron lb-vip-delete [-h] [--request-format {json,xml}] VIP
Delete a given vip.
Positional argumentsVIP
ID or name of vip to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lb-vip-listusage: neutron lb-vip-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List vips that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron lb-vip-showusage: neutron lb-vip-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
VIP
Show information of a given vip.
Positional argumentsVIP
ID or name of vip to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lb-vip-updateusage: neutron lb-vip-update [-h] [--request-format {json,xml}] VIP
Update a given vip.
Positional argumentsVIP
ID or name of vip to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lbaas-agent-hosting-loadbalancerusage: neutron lbaas-agent-hosting-loadbalancer [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}]
[-D] [-F FIELD]
loadbalancer
Get lbaas v2 agent hosting a loadbalancer. Deriving from ListCommand though
server will return only one agent to keep common output format for all agent
schedulers
Positional argumentsloadbalancer
LoadBalancer to query.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lbaas-healthmonitor-createusage: neutron lbaas-healthmonitor-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--admin-state-down]
[--expected-codes EXPECTED_CODES]
[--http-method HTTP_METHOD]
[--url-path URL_PATH] --delay DELAY
--max-retries MAX_RETRIES --timeout
TIMEOUT --type {PING,TCP,HTTP,HTTPS}
--pool POOL
LBaaS v2 Create a healthmonitor.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--expected-codes EXPECTED_CODES
The list of HTTP status codes expected in response
from the member to declare it healthy. This attribute
can contain one value, or a list of values separated
by comma, or a range of values (e.g. "200-299"). If
this attribute is not specified, it defaults to "200".
--http-method HTTP_METHOD
The HTTP method used for requests by the monitor of
type HTTP.
--url-path URL_PATH
The HTTP path used in the HTTP request used by the
monitor to test a member health. This must be a string
beginning with a / (forward slash).
--delay DELAY
The time in seconds between sending probes to members.
--max-retries MAX_RETRIES
Number of permissible connection failures before
changing the member status to INACTIVE. [1..10].
--timeout TIMEOUT
Maximum number of seconds for a monitor to wait for a
connection to be established before it times out. The
value must be less than the delay value.
--type {PING,TCP,HTTP,HTTPS}
One of the predefined health monitor types.
--pool POOL
ID or name of the pool that this healthmonitor will
monitor.
neutron lbaas-healthmonitor-deleteusage: neutron lbaas-healthmonitor-delete [-h] [--request-format {json,xml}]
HEALTHMONITOR
LBaaS v2 Delete a given healthmonitor.
Positional argumentsHEALTHMONITOR
ID or name of healthmonitor to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lbaas-healthmonitor-listusage: neutron lbaas-healthmonitor-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE]
[--sort-key FIELD]
[--sort-dir {asc,desc}]
LBaaS v2 List healthmonitors that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron lbaas-healthmonitor-showusage: neutron lbaas-healthmonitor-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
HEALTHMONITOR
LBaaS v2 Show information of a given healthmonitor.
Positional argumentsHEALTHMONITOR
ID or name of healthmonitor to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lbaas-healthmonitor-updateusage: neutron lbaas-healthmonitor-update [-h] [--request-format {json,xml}]
HEALTHMONITOR
LBaaS v2 Update a given healthmonitor.
Positional argumentsHEALTHMONITOR
ID of healthmonitor to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lbaas-listener-createusage: neutron lbaas-listener-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--admin-state-down]
[--connection-limit CONNECTION_LIMIT]
[--description DESCRIPTION] [--name NAME]
[--default-tls-container-ref DEFAULT_TLS_CONTAINER_REF]
[--sni-container-refs SNI_CONTAINER_REFS [SNI_CONTAINER_REFS ...]]
--loadbalancer LOADBALANCER --protocol
{TCP,HTTP,HTTPS,TERMINATED_HTTPS}
--protocol-port PORT
LBaaS v2 Create a listener.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--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 listener.
--name NAME
The name of the listener.
--default-tls-container-ref DEFAULT_TLS_CONTAINER_REF
Default TLS container reference to retrieve TLS
information.
--sni-container-refs SNI_CONTAINER_REFS [SNI_CONTAINER_REFS ...]
List of TLS container references for SNI.
--loadbalancer LOADBALANCER
ID or name of the load balancer.
--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS}
Protocol for the listener.
--protocol-port PORT
Protocol port for the listener.
neutron lbaas-listener-deleteusage: neutron lbaas-listener-delete [-h] [--request-format {json,xml}]
LISTENER
LBaaS v2 Delete a given listener.
Positional argumentsLISTENER
ID or name of listener to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lbaas-listener-listusage: neutron lbaas-listener-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
LBaaS v2 List listeners that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron lbaas-listener-showusage: neutron lbaas-listener-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
LISTENER
LBaaS v2 Show information of a given listener.
Positional argumentsLISTENER
ID or name of listener to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lbaas-listener-updateusage: neutron lbaas-listener-update [-h] [--request-format {json,xml}]
LISTENER
LBaaS v2 Update a given listener.
Positional argumentsLISTENER
ID of listener to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lbaas-loadbalancer-createusage: neutron lbaas-loadbalancer-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--description DESCRIPTION]
[--admin-state-down] [--name NAME]
[--provider PROVIDER]
[--vip-address VIP_ADDRESS]
VIP_SUBNET
LBaaS v2 Create a loadbalancer.
Positional argumentsVIP_SUBNET
Load balancer VIP subnet.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--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.
--vip-address VIP_ADDRESS
VIP address for the load balancer.
neutron lbaas-loadbalancer-deleteusage: neutron lbaas-loadbalancer-delete [-h] [--request-format {json,xml}]
LOADBALANCER
LBaaS v2 Delete a given loadbalancer.
Positional argumentsLOADBALANCER
ID or name of loadbalancer to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lbaas-loadbalancer-listusage: neutron lbaas-loadbalancer-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
LBaaS v2 List loadbalancers that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron lbaas-loadbalancer-list-on-agentusage: neutron lbaas-loadbalancer-list-on-agent [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}]
[-D] [-F FIELD]
lbaas_agent
List the loadbalancers on a loadbalancer v2 agent.
Positional argumentslbaas_agent
ID of the loadbalancer agent to query.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lbaas-loadbalancer-showusage: neutron lbaas-loadbalancer-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
LOADBALANCER
LBaaS v2 Show information of a given loadbalancer.
Positional argumentsLOADBALANCER
ID or name of loadbalancer to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lbaas-loadbalancer-updateusage: neutron lbaas-loadbalancer-update [-h] [--request-format {json,xml}]
LOADBALANCER
LBaaS v2 Update a given loadbalancer.
Positional argumentsLOADBALANCER
ID or name of loadbalancer to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lbaas-member-createusage: neutron lbaas-member-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--admin-state-down] [--weight WEIGHT]
--subnet SUBNET --address ADDRESS
--protocol-port PROTOCOL_PORT
POOL
LBaaS v2 Create a member.
Positional argumentsPOOL
ID or name of the pool that this member belongs to.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false
--weight WEIGHT
Weight of member in the pool (default:1, [0..256]).
--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-deleteusage: neutron lbaas-member-delete [-h] [--request-format {json,xml}]
MEMBER POOL
LBaaS v2 Delete a given member.
Positional argumentsMEMBER
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,xml}
The XML or JSON request format.
neutron lbaas-member-listusage: neutron lbaas-member-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
POOL
LBaaS v2 List members that belong to a given pool.
Positional argumentsPOOL
ID or name of the pool that this member belongs to.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron lbaas-member-showusage: neutron lbaas-member-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D] [-F FIELD]
MEMBER POOL
LBaaS v2 Show information of a given member.
Positional argumentsMEMBER
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,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lbaas-member-updateusage: neutron lbaas-member-update [-h] [--request-format {json,xml}]
[--admin-state-down] [--weight WEIGHT]
MEMBER POOL
LBaaS v2 Update a given member.
Positional argumentsMEMBER
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,xml}
The XML or JSON request format.
--admin-state-down
Set admin state up to false
--weight WEIGHT
Weight of member in the pool (default:1, [0..256])
neutron lbaas-pool-createusage: neutron lbaas-pool-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID] [--admin-state-down]
[--description DESCRIPTION]
[--session-persistence type=TYPE[,cookie_name=COOKIE_NAME]]
[--name NAME] --lb-algorithm
{ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}
--listener LISTENER --protocol
{HTTP,HTTPS,TCP}
LBaaS v2 Create a pool.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--description DESCRIPTION
Description of the pool.
--session-persistence
type=TYPE[,cookie_name=COOKIE_NAME]
The type of session persistence to use and associated
cookie name
--name NAME
The name of the pool.
--lb-algorithm {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}
The algorithm used to distribute load between the
members of the pool.
--listener LISTENER
The listener to associate with the pool
--protocol {HTTP,HTTPS,TCP}
Protocol for balancing.
neutron lbaas-pool-deleteusage: neutron lbaas-pool-delete [-h] [--request-format {json,xml}] POOL
LBaaS v2 Delete a given pool.
Positional argumentsPOOL
ID or name of pool to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron lbaas-pool-listusage: neutron lbaas-pool-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
LBaaS v2 List pools that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron lbaas-pool-showusage: neutron lbaas-pool-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
POOL
LBaaS v2 Show information of a given pool.
Positional argumentsPOOL
ID or name of pool to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron lbaas-pool-updateusage: neutron lbaas-pool-update [-h] [--request-format {json,xml}] POOL
LBaaS v2 Update a given pool.
Positional argumentsPOOL
ID or name of pool to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron meter-label-createusage: neutron meter-label-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--description DESCRIPTION] [--shared]
NAME
Create a metering label for a given tenant.
Positional argumentsNAME
Name of metering label to create.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description of metering label to create.
--shared
Set the label as shared.
neutron meter-label-deleteusage: neutron meter-label-delete [-h] [--request-format {json,xml}]
METERING_LABEL
Delete a given metering label.
Positional argumentsMETERING_LABEL
ID or name of metering_label to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron meter-label-listusage: neutron meter-label-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List metering labels that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron meter-label-rule-createusage: neutron meter-label-rule-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--direction {ingress,egress}]
[--excluded]
LABEL REMOTE_IP_PREFIX
Create a metering label rule for a given label.
Positional argumentsLABEL
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,xml}
The XML or JSON request format.
--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-deleteusage: neutron meter-label-rule-delete [-h] [--request-format {json,xml}]
METERING_LABEL_RULE
Delete a given metering label.
Positional argumentsMETERING_LABEL_RULE
ID or name of metering_label_rule to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron meter-label-rule-listusage: neutron meter-label-rule-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List metering labels that belong to a given label.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron meter-label-rule-showusage: neutron meter-label-rule-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
METERING_LABEL_RULE
Show information of a given metering label rule.
Positional argumentsMETERING_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,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron meter-label-showusage: neutron meter-label-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D] [-F FIELD]
METERING_LABEL
Show information of a given metering label.
Positional argumentsMETERING_LABEL
ID or name of metering_label to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron net-createusage: neutron net-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--tenant-id TENANT_ID] [--admin-state-down]
[--shared] [--provider:network_type <network_type>]
[--provider:physical_network <physical_network_name>]
[--provider:segmentation_id <segmentation_id>]
[--vlan-transparent {True,False}]
[--qos-policy QOS_POLICY]
NAME
Create a network for a given tenant.
Positional argumentsNAME
Name of network to create.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--shared
Set the network as shared.
--provider:network_type <network_type>
The physical mechanism by which the virtual network is
implemented.
--provider:physical_network <physical_network_name>
Name of the physical network over which the virtual
network is implemented.
--provider:segmentation_id <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.
neutron net-deleteusage: neutron net-delete [-h] [--request-format {json,xml}] NETWORK
Delete a given network.
Positional argumentsNETWORK
ID or name of network to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron net-external-listusage: neutron net-external-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List external networks that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron net-gateway-connectusage: neutron net-gateway-connect [-h] [--request-format {json,xml}]
[--segmentation-type SEGMENTATION_TYPE]
[--segmentation-id SEGMENTATION_ID]
NET-GATEWAY-ID NETWORK-ID
Add an internal network interface to a router.
Positional argumentsNET-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,xml}
The XML or JSON request format.
--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-createusage: neutron net-gateway-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--device id=ID,interface_name=NAME_OR_ID]
NAME
Create a network gateway.
Positional argumentsNAME
Name of network gateway to create.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--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-deleteusage: neutron net-gateway-delete [-h] [--request-format {json,xml}]
NETWORK_GATEWAY
Delete a given network gateway.
Positional argumentsNETWORK_GATEWAY
ID or name of network_gateway to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron net-gateway-disconnectusage: neutron net-gateway-disconnect [-h] [--request-format {json,xml}]
[--segmentation-type SEGMENTATION_TYPE]
[--segmentation-id SEGMENTATION_ID]
NET-GATEWAY-ID NETWORK-ID
Remove a network from a network gateway.
Positional argumentsNET-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,xml}
The XML or JSON request format.
--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-listusage: neutron net-gateway-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
List network gateways for a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron net-gateway-showusage: neutron net-gateway-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D] [-F FIELD]
NETWORK_GATEWAY
Show information of a given network gateway.
Positional argumentsNETWORK_GATEWAY
ID or name of network_gateway to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron net-gateway-updateusage: neutron net-gateway-update [-h] [--request-format {json,xml}]
NETWORK_GATEWAY
Update the name for a network gateway.
Positional argumentsNETWORK_GATEWAY
ID or name of network_gateway to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron net-listusage: neutron net-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
List networks that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron net-list-on-dhcp-agentusage: neutron net-list-on-dhcp-agent [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
dhcp_agent
List the networks on a DHCP agent.
Positional argumentsdhcp_agent
ID of the DHCP agent.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron net-showusage: neutron net-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--prefix PREFIX]
[--request-format {json,xml}] [-D] [-F FIELD]
NETWORK
Show information of a given network.
Positional argumentsNETWORK
ID or name of network to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron net-updateusage: neutron net-update [-h] [--request-format {json,xml}]
[--qos-policy QOS_POLICY | --no-qos-policy]
NETWORK
Update network's information.
Positional argumentsNETWORK
ID or name of network to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--qos-policy QOS_POLICY
Attach QoS policy ID or name to the resource.
--no-qos-policy
Detach QoS policy from the resource.
neutron nuage-netpartition-createusage: neutron nuage-netpartition-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
name
Create a netpartition for a given tenant.
Positional argumentsname
Name of netpartition to create.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
neutron nuage-netpartition-deleteusage: neutron nuage-netpartition-delete [-h] [--request-format {json,xml}]
NET_PARTITION
Delete a given netpartition.
Positional argumentsNET_PARTITION
ID or name of net_partition to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron nuage-netpartition-listusage: neutron nuage-netpartition-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD]
List netpartitions that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron nuage-netpartition-showusage: neutron nuage-netpartition-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
NET_PARTITION
Show information of a given netpartition.
Positional argumentsNET_PARTITION
ID or name of net_partition to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron port-createusage: neutron port-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--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 <direct | macvtap | normal>]
[--binding-profile BINDING_PROFILE]
[--security-group SECURITY_GROUP | --no-security-groups]
[--extra-dhcp-opt EXTRA_DHCP_OPTS]
[--qos-policy QOS_POLICY]
NETWORK
Create a port for a given tenant.
Positional argumentsNETWORK
Network ID or name this port belongs to.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--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=<name_or_id>,ip_address=<ip>. 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 <direct | macvtap | normal>
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=<dhcp_option_name>,opt_value=<value>,ip_version={4,
6}. You can repeat this option.
--qos-policy QOS_POLICY
Attach QoS policy ID or name to the resource.
neutron port-deleteusage: neutron port-delete [-h] [--request-format {json,xml}] PORT
Delete a given port.
Positional argumentsPORT
ID or name of port to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron port-listusage: neutron port-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
List ports that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron port-showusage: neutron port-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--prefix PREFIX]
[--request-format {json,xml}] [-D] [-F FIELD]
PORT
Show information of a given port.
Positional argumentsPORT
ID or name of port to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron port-updateusage: neutron port-update [-h] [--request-format {json,xml}] [--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]
PORT
Update port's information.
Positional argumentsPORT
ID or name of port to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--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=<name_or_id>,ip_address=<ip>. 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=<dhcp_option_name>,opt_value=<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.
neutron qos-available-rule-typesusage: neutron qos-available-rule-types [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE]
[--sort-key FIELD]
[--sort-dir {asc,desc}]
List available qos rule types.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron qos-bandwidth-limit-rule-createusage: neutron qos-bandwidth-limit-rule-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--max-kbps MAX_KBPS]
[--max-burst-kbps MAX_BURST_KBPS]
QOS_POLICY
Create a qos bandwidth limit rule.
Positional argumentsQOS_POLICY
ID or name of the QoS policy.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--max-kbps MAX_KBPS
max bandwidth in kbps.
--max-burst-kbps MAX_BURST_KBPS
max burst bandwidth in kbps.
neutron qos-bandwidth-limit-rule-deleteusage: neutron qos-bandwidth-limit-rule-delete [-h]
[--request-format {json,xml}]
BANDWIDTH_LIMIT_RULE QOS_POLICY
Delete a given qos bandwidth limit rule.
Positional argumentsBANDWIDTH_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,xml}
The XML or JSON request format.
neutron qos-bandwidth-limit-rule-listusage: neutron qos-bandwidth-limit-rule-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}]
[-D] [-F FIELD] [-P SIZE]
[--sort-key FIELD]
[--sort-dir {asc,desc}]
QOS_POLICY
List all qos bandwidth limit rules belonging to the specified policy.
Positional argumentsQOS_POLICY
ID or name of the QoS policy.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron qos-bandwidth-limit-rule-showusage: neutron qos-bandwidth-limit-rule-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[-D] [-F FIELD]
BANDWIDTH_LIMIT_RULE QOS_POLICY
Show information about the given qos bandwidth limit rule.
Positional argumentsBANDWIDTH_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,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron qos-bandwidth-limit-rule-updateusage: neutron qos-bandwidth-limit-rule-update [-h]
[--request-format {json,xml}]
[--max-kbps MAX_KBPS]
[--max-burst-kbps MAX_BURST_KBPS]
BANDWIDTH_LIMIT_RULE QOS_POLICY
Update the given qos bandwidth limit rule.
Positional argumentsBANDWIDTH_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,xml}
The XML or JSON request format.
--max-kbps MAX_KBPS
max bandwidth in kbps.
--max-burst-kbps MAX_BURST_KBPS
max burst bandwidth in kbps.
neutron qos-policy-createusage: neutron qos-policy-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--description DESCRIPTION] [--shared]
NAME
Create a qos policy.
Positional argumentsNAME
Name of QoS policy to create.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description of the QoS policy.
--shared
Accessible by other tenants. Set shared to True
(default is False).
neutron qos-policy-deleteusage: neutron qos-policy-delete [-h] [--request-format {json,xml}] POLICY
Delete a given qos policy.
Positional argumentsPOLICY
ID or name of policy to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron qos-policy-listusage: neutron qos-policy-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List QoS policies that belong to a given tenant connection.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron qos-policy-showusage: neutron qos-policy-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
POLICY
Show information of a given qos policy.
Positional argumentsPOLICY
ID or name of policy to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron qos-policy-updateusage: neutron qos-policy-update [-h] [--request-format {json,xml}]
[--name NAME] [--description DESCRIPTION]
[--shared]
POLICY
Update a given qos policy.
Positional argumentsPOLICY
ID or name of policy to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--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-createusage: neutron queue-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--tenant-id TENANT_ID] [--min MIN] [--max MAX]
[--qos-marking QOS_MARKING] [--default DEFAULT]
[--dscp DSCP]
NAME
Create a queue.
Positional argumentsNAME
Name of queue.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--min 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-deleteusage: neutron queue-delete [-h] [--request-format {json,xml}] QOS_QUEUE
Delete a given queue.
Positional argumentsQOS_QUEUE
ID or name of qos_queue to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron queue-listusage: neutron queue-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
List queues that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron queue-showusage: neutron queue-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}] [-D]
[-F FIELD]
QOS_QUEUE
Show information of a given queue.
Positional argumentsQOS_QUEUE
ID or name of qos_queue to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron quota-deleteusage: neutron quota-delete [-h] [--request-format {json,xml}]
[--tenant-id tenant-id]
Delete defined quotas of a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id
tenant-id
The owner tenant ID.
neutron quota-listusage: neutron quota-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}]
List quotas of all tenants who have non-default quota values.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron quota-showusage: neutron quota-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--tenant-id tenant-id]
Show quotas of a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id
tenant-id
The owner tenant ID.
neutron quota-updateusage: neutron quota-update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--tenant-id tenant-id] [--network networks]
[--subnet subnets] [--port ports]
[--router routers] [--floatingip floatingips]
[--security-group security_groups]
[--security-group-rule security_group_rules]
[--vip vips] [--pool pools] [--member members]
[--health-monitor health_monitors]
Define tenant's quotas not to use defaults.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id
tenant-id
The owner tenant ID.
--network
networks The limit of networks.
--subnet
subnets The limit of subnets.
--port
ports The limit of ports.
--router
routers The limit of routers.
--floatingip
floatingips
The limit of floating IPs.
--security-group
security_groups
The limit of security groups.
--security-group-rule
security_group_rules
The limit of security groups rules.
--vip
vips The limit of vips.
--pool
pools The limit of pools.
--member
members The limit of pool members.
--health-monitor
health_monitors
The limit of health monitors.
neutron rbac-createusage: neutron rbac-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--tenant-id TENANT_ID] --type {network}
[--target-tenant TARGET_TENANT] --action
{access_as_external,access_as_shared}
RBAC_OBJECT
Create a RBAC policy for a given tenant.
Positional argumentsRBAC_OBJECT
ID or name of the RBAC object.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--type {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-deleteusage: neutron rbac-delete [-h] [--request-format {json,xml}] RBAC_POLICY
Delete a RBAC policy.
Positional argumentsRBAC_POLICY
ID or name of rbac_policy to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron rbac-listusage: neutron rbac-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
List RBAC policies that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron rbac-showusage: neutron rbac-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--prefix PREFIX]
[--request-format {json,xml}] [-D] [-F FIELD]
RBAC_POLICY
Show information of a given RBAC policy.
Positional argumentsRBAC_POLICY
ID or name of rbac_policy to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron rbac-updateusage: neutron rbac-update [-h] [--request-format {json,xml}]
[--target-tenant TARGET_TENANT]
RBAC_POLICY
Update RBAC policy for given tenant.
Positional argumentsRBAC_POLICY
ID or name of rbac_policy to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--target-tenant TARGET_TENANT
ID of the tenant to which the RBAC policy will be
enforced.
neutron router-createusage: neutron router-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--tenant-id TENANT_ID] [--admin-state-down]
[--distributed {True,False}] [--ha {True,False}]
NAME
Create a router for a given tenant.
Positional argumentsNAME
Name of router to create.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--distributed {True,False}
Create a distributed router.
--ha {True,False}
Create a highly available router.
neutron router-deleteusage: neutron router-delete [-h] [--request-format {json,xml}] ROUTER
Delete a given router.
Positional argumentsROUTER
ID or name of router to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron router-gateway-clearusage: neutron router-gateway-clear [-h] [--request-format {json,xml}] ROUTER
Remove an external network gateway from a router.
Positional argumentsROUTER
ID or name of the router.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron router-gateway-setusage: neutron router-gateway-set [-h] [--request-format {json,xml}]
[--disable-snat] [--fixed-ip FIXED_IP]
ROUTER EXTERNAL-NETWORK
Set the external network gateway for a router.
Positional argumentsROUTER
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,xml}
The XML or JSON request format.
--disable-snat
Disable source NAT on the router gateway.
--fixed-ip FIXED_IP
Desired IP and/or subnet on external network:
subnet_id=<name_or_id>,ip_address=<ip>. You can repeat
this option.
neutron router-interface-addusage: neutron router-interface-add [-h] [--request-format {json,xml}]
ROUTER INTERFACE
Add an internal network interface to a router.
Positional argumentsROUTER
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,xml}
The XML or JSON request format.
neutron router-interface-deleteusage: neutron router-interface-delete [-h] [--request-format {json,xml}]
ROUTER INTERFACE
Remove an internal network interface from a router.
Positional argumentsROUTER
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,xml}
The XML or JSON request format.
neutron router-listusage: neutron router-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List routers that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron router-list-on-l3-agentusage: neutron router-list-on-l3-agent [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD]
l3_agent
List the routers on a L3 agent.
Positional argumentsl3_agent
ID of the L3 agent to query.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron router-port-listusage: neutron router-port-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
router
List ports that belong to a given tenant, with specified router.
Positional argumentsrouter
ID or name of router to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-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-showusage: neutron router-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
ROUTER
Show information of a given router.
Positional argumentsROUTER
ID or name of router to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron router-updateusage: neutron router-update [-h] [--request-format {json,xml}] [--name NAME]
[--admin-state-up {True,False}]
[--distributed {True,False}]
ROUTER
Update router's information.
Positional argumentsROUTER
ID or name of router to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--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.
neutron security-group-createusage: neutron security-group-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--description DESCRIPTION]
NAME
Create a security group.
Positional argumentsNAME
Name of security group.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description of security group.
neutron security-group-deleteusage: neutron security-group-delete [-h] [--request-format {json,xml}]
SECURITY_GROUP
Delete a given security group.
Positional argumentsSECURITY_GROUP
ID or name of security_group to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron security-group-listusage: neutron security-group-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List security groups that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron security-group-rule-createusage: neutron security-group-rule-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--direction {ingress,egress}]
[--ethertype ETHERTYPE]
[--protocol PROTOCOL]
[--port-range-min PORT_RANGE_MIN]
[--port-range-max PORT_RANGE_MAX]
[--remote-ip-prefix REMOTE_IP_PREFIX]
[--remote-group-id REMOTE_GROUP]
SECURITY_GROUP
Create a security group rule.
Positional argumentsSECURITY_GROUP
Security group name or ID to add rule.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--direction {ingress,egress}
Direction of traffic: ingress/egress.
--ethertype ETHERTYPE
IPv4/IPv6
--protocol PROTOCOL
Protocol of packet.
--port-range-min PORT_RANGE_MIN
Starting port range.
--port-range-max PORT_RANGE_MAX
Ending port range.
--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-deleteusage: neutron security-group-rule-delete [-h] [--request-format {json,xml}]
SECURITY_GROUP_RULE
Delete a given security group rule.
Positional argumentsSECURITY_GROUP_RULE
ID of security_group_rule to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron security-group-rule-listusage: neutron security-group-rule-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE]
[--sort-key FIELD]
[--sort-dir {asc,desc}]
[--no-nameconv]
List security group rules that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
--no-nameconv
Do not convert security group ID to its name.
neutron security-group-rule-showusage: neutron security-group-rule-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
SECURITY_GROUP_RULE
Show information of a given security group rule.
Positional argumentsSECURITY_GROUP_RULE
ID of security_group_rule to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron security-group-showusage: neutron security-group-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
SECURITY_GROUP
Show information of a given security group.
Positional argumentsSECURITY_GROUP
ID or name of security_group to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron security-group-updateusage: neutron security-group-update [-h] [--request-format {json,xml}]
[--name NAME] [--description DESCRIPTION]
SECURITY_GROUP
Update a given security group.
Positional argumentsSECURITY_GROUP
ID or name of security_group to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--name NAME
Name of security group.
--description DESCRIPTION
Description of security group.
neutron service-provider-listusage: neutron service-provider-list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List service providers.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron subnet-createusage: neutron subnet-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[--tenant-id TENANT_ID] [--name NAME]
[--gateway GATEWAY_IP | --no-gateway]
[--allocation-pool start=IP_ADDR,end=IP_ADDR]
[--host-route destination=CIDR,nexthop=IP_ADDR]
[--dns-nameserver DNS_NAMESERVER]
[--disable-dhcp] [--enable-dhcp]
[--ip-version {4,6}]
[--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
[--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
[--subnetpool SUBNETPOOL]
[--prefixlen PREFIX_LENGTH]
NETWORK [CIDR]
Create a subnet for a given tenant.
Positional argumentsNETWORK
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,xml}
The XML or JSON request format.
--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.
--prefixlen PREFIX_LENGTH
Prefix length for subnet allocation from subnetpool.
neutron subnet-deleteusage: neutron subnet-delete [-h] [--request-format {json,xml}] SUBNET
Delete a given subnet.
Positional argumentsSUBNET
ID or name of subnet to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron subnet-listusage: neutron subnet-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List subnets that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron subnet-showusage: neutron subnet-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
SUBNET
Show information of a given subnet.
Positional argumentsSUBNET
ID or name of subnet to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron subnet-updateusage: neutron subnet-update [-h] [--request-format {json,xml}] [--name NAME]
[--gateway GATEWAY_IP | --no-gateway]
[--allocation-pool start=IP_ADDR,end=IP_ADDR]
[--host-route destination=CIDR,nexthop=IP_ADDR]
[--dns-nameserver DNS_NAMESERVER]
[--disable-dhcp] [--enable-dhcp]
SUBNET
Update subnet's information.
Positional argumentsSUBNET
ID or name of subnet to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--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-createusage: neutron subnetpool-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--min-prefixlen MIN_PREFIXLEN]
[--max-prefixlen MAX_PREFIXLEN]
[--default-prefixlen DEFAULT_PREFIXLEN]
[--pool-prefix PREFIXES] [--shared]
[--address-scope ADDRSCOPE]
name
Create a subnetpool for a given tenant.
Positional argumentsname
Name of subnetpool to create.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--min-prefixlen MIN_PREFIXLEN
Subnetpool minimum prefix length.
--max-prefixlen MAX_PREFIXLEN
Subnetpool maximum prefix length.
--default-prefixlen DEFAULT_PREFIXLEN
Subnetpool default prefix length.
--pool-prefix PREFIXES
Subnetpool prefixes (This option can be repeated).
--shared
Set the subnetpool as shared.
--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-deleteusage: neutron subnetpool-delete [-h] [--request-format {json,xml}] SUBNETPOOL
Delete a given subnetpool.
Positional argumentsSUBNETPOOL
ID or name of subnetpool to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron subnetpool-listusage: neutron subnetpool-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List subnetpools that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron subnetpool-showusage: neutron subnetpool-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--request-format {json,xml}]
[-D] [-F FIELD]
SUBNETPOOL
Show information of a given subnetpool.
Positional argumentsSUBNETPOOL
ID or name of subnetpool to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron subnetpool-updateusage: neutron subnetpool-update [-h] [--request-format {json,xml}]
[--min-prefixlen MIN_PREFIXLEN]
[--max-prefixlen MAX_PREFIXLEN]
[--default-prefixlen DEFAULT_PREFIXLEN]
[--pool-prefix PREFIXES] [--name NAME]
[--address-scope ADDRSCOPE | --no-address-scope]
SUBNETPOOL
Update subnetpool's information.
Positional argumentsSUBNETPOOL
ID or name of subnetpool to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--min-prefixlen MIN_PREFIXLEN
Subnetpool minimum prefix length.
--max-prefixlen MAX_PREFIXLEN
Subnetpool maximum prefix length.
--default-prefixlen DEFAULT_PREFIXLEN
Subnetpool default prefix length.
--pool-prefix PREFIXES
Subnetpool prefixes (This option can be repeated).
--name NAME
Name of subnetpool to update.
--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-ikepolicy-createusage: neutron vpn-ikepolicy-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--description DESCRIPTION]
[--auth-algorithm {sha1}]
[--encryption-algorithm ENCRYPTION_ALGORITHM]
[--phase1-negotiation-mode {main}]
[--ike-version {v1,v2}]
[--pfs {group2,group5,group14}]
[--lifetime units=UNITS,value=VALUE]
NAME
Create an IKE policy.
Positional argumentsNAME
Name of the IKE policy.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--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-deleteusage: neutron vpn-ikepolicy-delete [-h] [--request-format {json,xml}]
IKEPOLICY
Delete a given IKE policy.
Positional argumentsIKEPOLICY
ID or name of ikepolicy to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron vpn-ikepolicy-listusage: neutron vpn-ikepolicy-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List IKE policies that belong to a tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron vpn-ikepolicy-showusage: neutron vpn-ikepolicy-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
IKEPOLICY
Show information of a given IKE policy.
Positional argumentsIKEPOLICY
ID or name of ikepolicy to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron vpn-ikepolicy-updateusage: neutron vpn-ikepolicy-update [-h] [--request-format {json,xml}]
[--lifetime units=UNITS,value=VALUE]
IKEPOLICY
Update a given IKE policy.
Positional argumentsIKEPOLICY
ID or name of ikepolicy to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--lifetime
units=UNITS,value=VALUE
IKE lifetime attributes. 'units'-seconds,
default:seconds. 'value'-non negative integer,
default:3600.
neutron vpn-ipsecpolicy-createusage: neutron vpn-ipsecpolicy-create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID]
[--description DESCRIPTION]
[--transform-protocol {esp,ah,ah-esp}]
[--auth-algorithm {sha1}]
[--encryption-algorithm ENCRYPTION_ALGORITHM]
[--encapsulation-mode {tunnel,transport}]
[--pfs {group2,group5,group14}]
[--lifetime units=UNITS,value=VALUE]
NAME
Create an IPsec policy.
Positional argumentsNAME
Name of the IPsec policy.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--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-deleteusage: neutron vpn-ipsecpolicy-delete [-h] [--request-format {json,xml}]
IPSECPOLICY
Delete a given IPsec policy.
Positional argumentsIPSECPOLICY
ID or name of ipsecpolicy to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron vpn-ipsecpolicy-listusage: neutron vpn-ipsecpolicy-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D]
[-F FIELD] [-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List IPsec policies that belong to a given tenant connection.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron vpn-ipsecpolicy-showusage: neutron vpn-ipsecpolicy-show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D]
[-F FIELD]
IPSECPOLICY
Show information of a given IPsec policy.
Positional argumentsIPSECPOLICY
ID or name of ipsecpolicy to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron vpn-ipsecpolicy-updateusage: neutron vpn-ipsecpolicy-update [-h] [--request-format {json,xml}]
[--lifetime units=UNITS,value=VALUE]
IPSECPOLICY
Update a given IPsec policy.
Positional argumentsIPSECPOLICY
ID or name of ipsecpolicy to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--lifetime
units=UNITS,value=VALUE
IPsec lifetime attributes. 'units'-seconds,
default:seconds. 'value'-non negative integer,
default:3600.
neutron vpn-service-createusage: neutron vpn-service-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}]
[--tenant-id TENANT_ID] [--admin-state-down]
[--name NAME] [--description DESCRIPTION]
ROUTER SUBNET
Create a VPN service.
Positional argumentsROUTER
Router unique identifier for the VPN service.
SUBNET
Subnet unique identifier for the VPN service
deployment.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
--tenant-id TENANT_ID
The owner tenant ID.
--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-deleteusage: neutron vpn-service-delete [-h] [--request-format {json,xml}]
VPNSERVICE
Delete a given VPN service.
Positional argumentsVPNSERVICE
ID or name of vpnservice to delete.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
neutron vpn-service-listusage: neutron vpn-service-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--request-format {json,xml}] [-D] [-F FIELD]
[-P SIZE] [--sort-key FIELD]
[--sort-dir {asc,desc}]
List VPN service configurations that belong to a given tenant.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one
request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the
specified directions. You can repeat this option, but
you must specify an equal number of sort_dir and
sort_key values. Extra sort_dir options are ignored.
Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can
repeat this option.
neutron vpn-service-showusage: neutron vpn-service-show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--prefix PREFIX]
[--request-format {json,xml}] [-D] [-F FIELD]
VPNSERVICE
Show information of a given VPN service.
Positional argumentsVPNSERVICE
ID or name of vpnservice to look up.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can
repeat this option.
neutron vpn-service-updateusage: neutron vpn-service-update [-h] [--request-format {json,xml}]
VPNSERVICE
Update a given VPN service.
Positional argumentsVPNSERVICE
ID or name of vpnservice to update.
Optional arguments-h, --help
show this help message and exit
--request-format {json,xml}
The XML or JSON request format.