Chapter 9. Networking command-line client

--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.

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 tenant.

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.

nec-packet-filter-create

Create a packet filter for a given tenant.

nec-packet-filter-delete

Delete a given packet filter.

nec-packet-filter-list

List packet filters that belong to a given tenant.

nec-packet-filter-show

Show information of a given packet filter.

nec-packet-filter-update

Update packet filter's information.

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.

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.

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.

Positional arguments

AGENT

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.

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.

Positional arguments

AGENT

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.

Positional arguments

AGENT

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.

Positional arguments

credential_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.

Positional arguments

CREDENTIAL

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.

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.

Positional arguments

CREDENTIAL

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.

Positional arguments

name

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.

Positional arguments

NETWORK_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.

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.

Positional arguments

NETWORK_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.

Positional arguments

NETWORK_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.

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.

Positional arguments

POLICY_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.

Positional arguments

POLICY_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.

Positional arguments

network

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.

Positional arguments

dhcp_agent

ID of the DHCP agent.

network

Network to add.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

Positional arguments

dhcp_agent

ID of the DHCP agent.

network

Network to remove.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

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.

Positional arguments

EXTENSION

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.

Positional arguments

POLICY

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.

--shared

Set shared to True (default is False).

--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)

Positional arguments

FIREWALL

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.

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.

Positional arguments

NAME

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.

Positional arguments

FIREWALL_POLICY

ID or name of firewall_policy to delete.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

Positional arguments

FIREWALL_POLICY

ID or name of firewall_policy to update.

FIREWALL_RULE

New rule to insert.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

--insert-before FIREWALL_RULE

Insert before this rule.

--insert-after FIREWALL_RULE

Insert after this rule.

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.

Positional arguments

FIREWALL_POLICY

ID or name of firewall_policy to update.

FIREWALL_RULE

Firewall rule to remove from policy.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

Positional arguments

FIREWALL_POLICY

ID or name of firewall_policy to look up.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

FIREWALL_POLICY

ID or name of firewall_policy to update.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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"

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}

Action for the firewall rule.

Positional arguments

FIREWALL_RULE

ID or name of firewall_rule to delete.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

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.

Positional arguments

FIREWALL_RULE

ID or name of firewall_rule to look up.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

FIREWALL_RULE

ID or name of firewall_rule to update.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

--protocol {tcp,udp,icmp,any}

Protocol for the firewall rule.

Positional arguments

FIREWALL

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.

Positional arguments

FIREWALL

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)

Positional arguments

FLOATINGIP_ID

ID of the floating IP to associate.

PORT

ID or name of the port to be associated with the floating IP.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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).

Positional arguments

FLOATING_NETWORK

Network name or ID to allocate floating IP from.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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

Positional arguments

FLOATINGIP

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.

Positional arguments

FLOATINGIP_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.

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.

Positional arguments

FLOATINGIP

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.

Positional arguments

NAME

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.

Positional arguments

GATEWAY_DEVICE

ID or name of gateway_device to delete.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

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.

Positional arguments

GATEWAY_DEVICE

ID or name of gateway_device to look up.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

GATEWAY_DEVICE

ID or name of gateway_device to update.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

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.

Positional arguments

IPSEC_SITE_CONNECTION

ID or name of ipsec_site_connection to delete.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

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.

Positional arguments

IPSEC_SITE_CONNECTION

ID or name of ipsec_site_connection to look up.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

IPSEC_SITE_CONNECTION

ID or name of ipsec_site_connection to update.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

router

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.

Positional arguments

l3_agent

ID of the L3 agent.

router

Router to add.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

Positional arguments

l3_agent

ID of the L3 agent.

router

Router to remove.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

Positional arguments

pool

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.

Positional arguments

HEALTH_MONITOR_ID

Health monitor to associate.

POOL

ID of the pool to be associated with the health monitor.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

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.

Positional arguments

HEALTH_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.

Positional arguments

HEALTH_MONITOR_ID

Health monitor to associate.

POOL

ID of the pool to be associated with the health monitor.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

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.

Positional arguments

HEALTH_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.

Positional arguments

HEALTH_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.

Positional arguments

POOL

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.

Positional arguments

MEMBER

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.

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.

Positional arguments

MEMBER

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.

Positional arguments

MEMBER

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.

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.

Positional arguments

POOL

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.

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.

Positional arguments

lbaas_agent

ID of the loadbalancer agent to query.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

Positional arguments

POOL

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.

Positional arguments

POOL

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.

Positional arguments

POOL

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.

Positional arguments

POOL

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.

Positional arguments

VIP

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.

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.

Positional arguments

VIP

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.

Positional arguments

VIP

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.

Positional arguments

loadbalancer

LoadBalancer to query.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

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.

Positional arguments

HEALTHMONITOR

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.

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.

Positional arguments

HEALTHMONITOR

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.

Positional arguments

HEALTHMONITOR

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.

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-id DEFAULT_TLS_CONTAINER_ID

Default TLS container ID to retrieve TLS information.

--sni-container-ids SNI_CONTAINER_IDS [SNI_CONTAINER_IDS ...]

List of TLS container IDs for SNI.

--loadbalancer LOADBALANCER

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.

Positional arguments

LISTENER

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.

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.

Positional arguments

LISTENER

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.

Positional arguments

LISTENER

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.

Positional arguments

VIP_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.

Positional arguments

LOADBALANCER

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.

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.

Positional arguments

lbaas_agent

ID of the loadbalancer agent to query.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

Positional arguments

LOADBALANCER

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.

Positional arguments

LOADBALANCER

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.

Positional arguments

POOL

ID or name of the pool that this member belongs to.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

MEMBER

ID or name of member to delete.

POOL

ID or name of the pool that this member belongs to.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

Positional arguments

POOL

ID or name of the pool that this member belongs to.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

MEMBER

ID or name of member to look up.

POOL

ID or name of the pool that this member belongs to.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

MEMBER

ID or name of member to update.

POOL

ID or name of the pool that this member belongs to

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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])

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.

Positional arguments

POOL

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.

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.

Positional arguments

POOL

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.

Positional arguments

POOL

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.

Positional arguments

NAME

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.

Positional arguments

METERING_LABEL

ID or name of metering_label to delete.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

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.

Positional arguments

LABEL

Id or Name of the label.

REMOTE_IP_PREFIX

CIDR to match on.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

METERING_LABEL_RULE

ID or name of metering_label_rule to delete.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

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.

Positional arguments

METERING_LABEL_RULE

ID or name of metering_label_rule to look up.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

METERING_LABEL

ID or name of metering_label to look up.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

NETWORK

network to which this packet filter is applied

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

Name of this packet filter

--in-port PORT

Name or ID of the input port

--src-mac SRC_MAC

Source MAC address

--dst-mac DST_MAC

Destination MAC address

--eth-type ETH_TYPE

Ether Type. Integer [0:65535] (hex or decimal). E.g., 0x0800 (IPv4), 0x0806 (ARP), 0x86DD (IPv6)

--protocol PROTOCOL IP

Protocol. Protocol name or integer. Recognized names are icmp, tcp, udp, arp (case insensitive). Integer should be [0:255] (decimal or hex).

--src-cidr SRC_CIDR

Source IP address CIDR

--dst-cidr DST_CIDR

Destination IP address CIDR

--src-port SRC_PORT

Source port address

--dst-port DST_PORT

Destination port address

--priority PRIORITY

Priority of the filter. Integer of [0:65535]. Default: 30000.

--action {allow,drop}

Action of the filter. Default: allow

Positional arguments

PACKET_FILTER

ID or name of packet_filter to delete.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

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.

Positional arguments

PACKET_FILTER

ID or name of packet_filter 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.

Positional arguments

PACKET_FILTER

ID or name of packet_filter to update.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

--admin-state {True,False}

Set a value of Admin State Up

--name NAME

Name of this packet filter

--src-mac SRC_MAC

Source MAC address

--dst-mac DST_MAC

Destination MAC address

--eth-type ETH_TYPE

Ether Type. Integer [0:65535] (hex or decimal). E.g., 0x0800 (IPv4), 0x0806 (ARP), 0x86DD (IPv6)

--protocol PROTOCOL IP

Protocol. Protocol name or integer. Recognized names are icmp, tcp, udp, arp (case insensitive). Integer should be [0:255] (decimal or hex).

--src-cidr SRC_CIDR

Source IP address CIDR

--dst-cidr DST_CIDR

Destination IP address CIDR

--src-port SRC_PORT

Source port address

--dst-port DST_PORT

Destination port address

--priority PRIORITY

Priority of the filter. Integer of [0:65535].

--action {allow,drop}

Action of the filter.

Positional arguments

NAME

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.

--router:external

Set network as external, it is only available for admin

--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.

Positional arguments

NETWORK

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.

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.

Positional arguments

NET-GATEWAY-ID

ID of the network gateway.

NETWORK-ID

ID of the internal network to connect on the gateway.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

NAME

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.

Positional arguments

NETWORK_GATEWAY

ID or name of network_gateway to delete.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

Positional arguments

NET-GATEWAY-ID

ID of the network gateway.

NETWORK-ID

ID of the internal network to connect on the gateway.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

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.

Positional arguments

NETWORK_GATEWAY

ID or name of network_gateway to look up.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,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.

Positional arguments

NETWORK_GATEWAY

ID or name of network_gateway to update.

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The XML or JSON request format.

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.