Chapter 7. Networking command-line client

--version

show program's version number and exit

-v, --verbose, --debug

Increase verbosity of output and show tracebacks on errors. Can be repeated.

-q, --quiet

Suppress output except warnings and errors

-h, --help

Show this help message and exit

--os-auth-strategy <auth-strategy>

Authentication strategy (Env: OS_AUTH_STRATEGY, default keystone). For now, any other value will disable the authentication

--os-auth-url <auth-url>

Authentication URL (Env: OS_AUTH_URL)

--os-tenant-name <auth-tenant-name>

Authentication tenant name (Env: OS_TENANT_NAME)

--os-tenant-id <auth-tenant-id>

Authentication tenant name (Env: OS_TENANT_ID)

--os-username <auth-username>

Authentication username (Env: OS_USERNAME)

--os-password <auth-password>

Authentication password (Env: OS_PASSWORD)

--os-region-name <auth-region-name>

Authentication region name (Env: OS_REGION_NAME)

--os-token <token>

Defaults to env[OS_TOKEN]

--endpoint-type <endpoint-type>

Defaults to env[OS_ENDPOINT_TYPE] or publicURL.

--os-url <url>

Defaults to env[OS_URL]

--os-cacert <ca-certificate>

Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT]

--insecure

Explicitly allow 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

Update a given agent.

cisco-credential-create

Creates 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

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

complete

print bash completion command

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.

help

print detailed help for another command

ipsec-site-connection-create

Create an IPsecSiteConnection.

ipsec-site-connection-delete

Delete a given IPsecSiteConnection.

ipsec-site-connection-list

List IPsecSiteConnections that belong to a given tenant.

ipsec-site-connection-show

Show information of a given IPsecSiteConnection.

ipsec-site-connection-update

Update a given IPsecSiteConnection.

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

lb-healthmonitor-delete

Delete a given healthmonitor.

lb-healthmonitor-disassociate

Remove a mapping from a health monitor to a pool.

lb-healthmonitor-list

List healthmonitors that belong to a given tenant.

lb-healthmonitor-show

Show information of a given healthmonitor.

lb-healthmonitor-update

Update a given healthmonitor.

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.

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.

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.

vpn-ikepolicy-create

Create an IKEPolicy.

vpn-ikepolicy-delete

Delete a given IKE Policy.

vpn-ikepolicy-list

List IKEPolicies that belong to a tenant.

vpn-ikepolicy-show

Show information of a given IKEPolicy.

vpn-ikepolicy-update

Update a given IKE Policy.

vpn-ipsecpolicy-create

Create an ipsecpolicy.

vpn-ipsecpolicy-delete

Delete a given ipsecpolicy.

vpn-ipsecpolicy-list

List ipsecpolicies that belongs to a given tenant connection.

vpn-ipsecpolicy-show

Show information of a given ipsecpolicy.

vpn-ipsecpolicy-update

Update a given ipsec policy.

vpn-service-create

Create a VPNService.

vpn-service-delete

Delete a given VPNService.

vpn-service-list

List VPNService configurations that belong to a given tenant.

vpn-service-show

Show information of a given VPNService.

vpn-service-update

Update a given VPNService.

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

AGENT

ID or name of agent to update

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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_TENANT

Add tenant to the network profile

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

EXT-ALIAS

The extension alias

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

POLICY

Firewall policy 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 False)

--admin-state-down

Set admin state up to false

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

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

To 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

To set 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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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

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

--disabled

To 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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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

Positional arguments

FLOATINGIP_ID

ID of the floating IP to associate

PORT

ID or name of the port to be associated with the floatingip

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

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 floatingip

--fixed-ip-address FIXED_IP_ADDRESS

IP address on the port (only required if port has multipleIPs)

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 associate

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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

VPNService instance id associated with this connection

--ikepolicy-id IKEPOLICY

IKEPolicy id associated with this connection

--ipsecpolicy-id IPSECPOLICY

IPsecPolicy 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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 predefined health monitor types

Positional arguments

HEALTH_MONITOR

ID or name 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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

Positional arguments

HEALTH_MONITOR

ID or name 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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

HEALTH_MONITOR

ID or name 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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

Positional arguments

MEMBER

ID or name 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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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

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

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

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 DEVICE

Device info for this gateway device_id=<device identifier>,interface_name=<name_or_identifier> It can be repeated 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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

Positional arguments

dhcp_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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

Positional arguments

NETWORK

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

NETWORK

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

Positional arguments

NETWORK

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

--admin-state-down

Set admin state up to false

--mac-address MAC_ADDRESS

MAC address of this port

--device-id DEVICE_ID

Device id 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>, (This option can be repeated.)

--security-group SECURITY_GROUP

Security group associated with the port (This option can be repeated)

--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_name=<dhcp_option_name>,opt_value=<value>, (This option can be repeated.)

Positional arguments

PORT

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

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

Positional arguments

PORT

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

PORT

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

--security-group SECURITY_GROUP

Security group associated with the port (This option can be repeated)

--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_name=<dhcp_option_name>,opt_value=<value>, (This option can be repeated.)

Positional arguments

NAME

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

min-rate

--max MAX

max-rate

--qos-marking QOS_MARKING

QOS marking untrusted/trusted

--default DEFAULT

If true all ports created with be the size of this queue if queue is not specified

--dscp DSCP

Differentiated Services Code Point

Positional arguments

QOS_QUEUE

ID or name of qos_queue to delete

Optional arguments

-h, --help

show this help message and exit

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

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

QOS_QUEUE

ID or name of qos_queue to look up

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

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

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

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

Positional arguments

NAME

Name of router to create

distributed

Create a distributed router (VMware NSX plugin only)

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

Positional arguments

ROUTER

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

Positional arguments

router-id

ID of the router

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

Positional arguments

router-id

ID of the router

external-network-id

ID 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

Positional arguments

router-id

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

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

Positional arguments

router-id

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

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

Positional arguments

l3_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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

router

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

Positional arguments

ROUTER

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

ROUTER

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

Positional arguments

NAME

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

Positional arguments

SECURITY_GROUP

ID or name of security_group to delete

Optional arguments

-h, --help

show this help message and exit

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

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

Positional arguments

SECURITY_GROUP

Security group name or id to add rule.

Optional arguments

-h, --help

show this help message and exit

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

Positional arguments

SECURITY_GROUP_RULE

ID of security_group_rule to delete

Optional arguments

-h, --help

show this help message and exit

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

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

--no-nameconv

Do not convert security group ID to its name

Positional arguments

SECURITY_GROUP_RULE

ID of security_group_rule to look up

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

SECURITY_GROUP

ID or name of security_group to look up

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

SECURITY_GROUP

ID or name of security_group to update

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--name NAME

Name of security group

--description DESCRIPTION

Description of security group

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

Positional arguments

NETWORK

Network id or name this subnet belongs to

CIDR

CIDR of subnet to create

Optional arguments

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--tenant-id TENANT_ID

The owner tenant ID

--name NAME

Name of this subnet

--ip-version {4,6} IP

version with default 4

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

Positional arguments

SUBNET

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

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests

--sort-key FIELD

Sort list by specified fields (This option can be repeated), The number of sort_dir and sort_key should match each other, more sort_dir specified will be omitted, less will be filled with asc as default direction

--sort-dir {asc,desc}

Sort list in specified directions (This option can be repeated)

Positional arguments

SUBNET

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 info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server, can be repeated

Positional arguments

SUBNET

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