Chapter 77. vpn


This chapter describes the commands under the vpn command.

77.1. vpn endpoint group create

Usage:

openstack vpn endpoint group create [-h]

                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [--description <description>]
                                         --type TYPE --value ENDPOINTS
                                         [--project <project>]
                                         [--project-domain <project-domain>]
                                         <name>
Copy to Clipboard Toggle word wrap

Create an endpoint group

Expand
Table 77.1. Positional Arguments
ValueSummary

<name>

Name for the endpoint group

Expand
Table 77.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the endpoint group

--type TYPE

Type of endpoints in group (e.g. subnet, cidr)

--value ENDPOINTS

Endpoint(s) for the group. must all be of the same type. (--value) option can be repeated

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

Expand
Table 77.3. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 77.4. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.6. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

77.2. vpn endpoint group delete

Usage:

openstack vpn endpoint group delete [-h]

                                         <endpoint-group>
                                         [<endpoint-group> ...]
Copy to Clipboard Toggle word wrap

Delete endpoint group(s)

Expand
Table 77.7. Positional Arguments
ValueSummary

<endpoint-group>

Endpoint group(s) to delete (name or id)

Expand
Table 77.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-neutronclient plugin.

77.3. vpn endpoint group list

Usage:

openstack vpn endpoint group list [-h] [-f {csv,json,table,value,yaml}]

                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN] [--long]
Copy to Clipboard Toggle word wrap

List endpoint groups that belong to a given project

Expand
Table 77.9. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 77.10. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 77.11. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.13. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-neutronclient plugin.

77.4. vpn endpoint group set

Usage:

openstack vpn endpoint group set [-h] [--description <description>]

                                      [--name <name>]
                                      <endpoint-group>
Copy to Clipboard Toggle word wrap

Set endpoint group properties

Expand
Table 77.14. Positional Arguments
ValueSummary

<endpoint-group>

Endpoint group to set (name or id)

Expand
Table 77.15. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the endpoint group

--name <name>

Set a name for the endpoint group

This command is provided by the python-neutronclient plugin.

77.5. vpn endpoint group show

Usage:

openstack vpn endpoint group show [-h]

                                       [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <endpoint-group>
Copy to Clipboard Toggle word wrap

Display endpoint group details

Expand
Table 77.16. Positional Arguments
ValueSummary

<endpoint-group>

Endpoint group to display (name or id)

Expand
Table 77.17. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 77.18. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 77.19. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.20. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.21. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

77.6. vpn ike policy create

Usage:

openstack vpn ike policy create [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--description <description>]
                                     [--auth-algorithm {sha1,sha256,sha384,sha512}]
                                     [--encryption-algorithm {aes-128,3des,aes-192,aes-256}]
                                     [--phase1-negotiation-mode {main}]
                                     [--ike-version {v1,v2}]
                                     [--pfs {group5,group2,group14}]
                                     [--lifetime units=UNITS,value=VALUE]
                                     [--project <project>]
                                     [--project-domain <project-domain>]
                                     <name>
Copy to Clipboard Toggle word wrap

Create an IKE policy

Expand
Table 77.22. Positional Arguments
ValueSummary

<name>

Name of the ike policy

Expand
Table 77.23. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the IKE policy

--auth-algorithm {sha1,sha256,sha384,sha512}

Authentication algorithm

--encryption-algorithm {aes-128,3des,aes-192,aes-256}

Encryption algorithm

--phase1-negotiation-mode {main}

IKE Phase1 negotiation mode

--ike-version {v1,v2}

IKE version for the policy

--pfs {group5,group2,group14}

Perfect Forward Secrecy

--lifetime units=UNITS,value=VALUE

IKE lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

Expand
Table 77.24. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 77.25. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.26. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.27. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

77.7. vpn ike policy delete

Usage:

openstack vpn ike policy delete [-h] <ike-policy> [<ike-policy> ...]
Copy to Clipboard Toggle word wrap

Delete IKE policy (policies)

Expand
Table 77.28. Positional Arguments
ValueSummary

<ike-policy>

Ike policy to delete (name or id)

Expand
Table 77.29. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-neutronclient plugin.

77.8. vpn ike policy list

Usage:

openstack vpn ike policy list [-h] [-f {csv,json,table,value,yaml}]

                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN] [--long]
Copy to Clipboard Toggle word wrap

List IKE policies that belong to a given project

Expand
Table 77.30. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 77.31. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 77.32. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.33. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.34. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-neutronclient plugin.

77.9. vpn ike policy set

Usage:

openstack vpn ike policy set [-h] [--description <description>]

                                  [--auth-algorithm {sha1,sha256,sha384,sha512}]
                                  [--encryption-algorithm {aes-128,3des,aes-192,aes-256}]
                                  [--phase1-negotiation-mode {main}]
                                  [--ike-version {v1,v2}]
                                  [--pfs {group5,group2,group14}]
                                  [--lifetime units=UNITS,value=VALUE]
                                  [--name <name>]
                                  <ike-policy>
Copy to Clipboard Toggle word wrap

Set IKE policy properties

Expand
Table 77.35. Positional Arguments
ValueSummary

<ike-policy>

Ike policy to set (name or id)

Expand
Table 77.36. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the IKE policy

--auth-algorithm {sha1,sha256,sha384,sha512}

Authentication algorithm

--encryption-algorithm {aes-128,3des,aes-192,aes-256}

Encryption algorithm

--phase1-negotiation-mode {main}

IKE Phase1 negotiation mode

--ike-version {v1,v2}

IKE version for the policy

--pfs {group5,group2,group14}

Perfect Forward Secrecy

--lifetime units=UNITS,value=VALUE

IKE lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

--name <name>

Name of the ike policy

This command is provided by the python-neutronclient plugin.

77.10. vpn ike policy show

Usage:

openstack vpn ike policy show [-h] [-f {json,shell,table,value,yaml}]

                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--noindent] [--prefix PREFIX]
                                   <ike-policy>
Copy to Clipboard Toggle word wrap

Display IKE policy details

Expand
Table 77.37. Positional Arguments
ValueSummary

<ike-policy>

Ike policy to display (name or id)

Expand
Table 77.38. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 77.39. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 77.40. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.41. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.42. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

77.11. vpn ipsec policy create

Usage:

openstack vpn ipsec policy create [-h]

                                       [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--description <description>]
                                       [--auth-algorithm {sha1,sha256,sha384,sha512}]
                                       [--encapsulation-mode {tunnel,transport}]
                                       [--encryption-algorithm {3des,aes-128,aes-192,aes-256}]
                                       [--lifetime units=UNITS,value=VALUE]
                                       [--pfs {group2,group5,group14}]
                                       [--transform-protocol {esp,ah,ah-esp}]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       <name>
Copy to Clipboard Toggle word wrap

Create an IPsec policy

Expand
Table 77.43. Positional Arguments
ValueSummary

<name>

Name of the ipsec policy

Expand
Table 77.44. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the IPsec policy

--auth-algorithm {sha1,sha256,sha384,sha512}

Authentication algorithm for IPsec policy

--encapsulation-mode {tunnel,transport}

Encapsulation mode for IPsec policy

--encryption-algorithm {3des,aes-128,aes-192,aes-256}

Encryption algorithm for IPsec policy

--lifetime units=UNITS,value=VALUE

IPsec lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

--pfs {group2,group5,group14}

Perfect Forward Secrecy for IPsec policy

--transform-protocol {esp,ah,ah-esp}

Transform protocol for IPsec policy

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

Expand
Table 77.45. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 77.46. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.47. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.48. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

77.12. vpn ipsec policy delete

Usage:

openstack vpn ipsec policy delete [-h]

                                       <ipsec-policy> [<ipsec-policy> ...]
Copy to Clipboard Toggle word wrap

Delete IPsec policy(policies)

Expand
Table 77.49. Positional Arguments
ValueSummary

<ipsec-policy>

Ipsec policy to delete (name or id)

Expand
Table 77.50. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-neutronclient plugin.

77.13. vpn ipsec policy list

Usage:

openstack vpn ipsec policy list [-h] [-f {csv,json,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN] [--long]
Copy to Clipboard Toggle word wrap

List IPsec policies that belong to a given project

Expand
Table 77.51. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 77.52. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 77.53. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.54. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.55. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-neutronclient plugin.

77.14. vpn ipsec policy set

Usage:

openstack vpn ipsec policy set [-h] [--description <description>]

                                    [--auth-algorithm {sha1,sha256,sha384,sha512}]
                                    [--encapsulation-mode {tunnel,transport}]
                                    [--encryption-algorithm {3des,aes-128,aes-192,aes-256}]
                                    [--lifetime units=UNITS,value=VALUE]
                                    [--pfs {group2,group5,group14}]
                                    [--transform-protocol {esp,ah,ah-esp}]
                                    [--name <name>]
                                    <ipsec-policy>
Copy to Clipboard Toggle word wrap

Set IPsec policy properties

Expand
Table 77.56. Positional Arguments
ValueSummary

<ipsec-policy>

Ipsec policy to set (name or id)

Expand
Table 77.57. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the IPsec policy

--auth-algorithm {sha1,sha256,sha384,sha512}

Authentication algorithm for IPsec policy

--encapsulation-mode {tunnel,transport}

Encapsulation mode for IPsec policy

--encryption-algorithm {3des,aes-128,aes-192,aes-256}

Encryption algorithm for IPsec policy

--lifetime units=UNITS,value=VALUE

IPsec lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

--pfs {group2,group5,group14}

Perfect Forward Secrecy for IPsec policy

--transform-protocol {esp,ah,ah-esp}

Transform protocol for IPsec policy

--name <name>

Name of the ipsec policy

This command is provided by the python-neutronclient plugin.

77.15. vpn ipsec policy show

Usage:

openstack vpn ipsec policy show [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <ipsec-policy>
Copy to Clipboard Toggle word wrap

Display IPsec policy details

Expand
Table 77.58. Positional Arguments
ValueSummary

<ipsec-policy>

Ipsec policy to display (name or id)

Expand
Table 77.59. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 77.60. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 77.61. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.62. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.63. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

77.16. vpn ipsec site connection create

Usage:

openstack vpn ipsec site connection create [-h]

                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width]
                                                [--print-empty] [--noindent]
                                                [--prefix PREFIX]
                                                [--description <description>]
                                                [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
                                                [--mtu MTU]
                                                [--initiator {bi-directional,response-only}]
                                                [--peer-cidr PEER_CIDRS | --local-endpoint-group LOCAL_ENDPOINT_GROUP]
                                                [--peer-endpoint-group PEER_ENDPOINT_GROUP]
                                                [--enable | --disable]
                                                [--local-id LOCAL_ID]
                                                --peer-id PEER_ID
                                                --peer-address PEER_ADDRESS
                                                --psk PSK --vpnservice
                                                VPNSERVICE --ikepolicy
                                                IKEPOLICY --ipsecpolicy
                                                IPSECPOLICY
                                                [--project <project>]
                                                [--project-domain <project-domain>]
                                                <name>
Copy to Clipboard Toggle word wrap

Create an IPsec site connection

Expand
Table 77.64. Positional Arguments
ValueSummary

<name>

Set friendly name for the connection

Expand
Table 77.65. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the connection

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

--mtu MTU

Mtu size for the connection

--initiator {bi-directional,response-only}

Initiator state

--peer-cidr PEER_CIDRS

Remote subnet(s) in CIDR format. Cannot be specified when using endpoint groups. Only applicable, if subnet provided for VPN service.

--local-endpoint-group LOCAL_ENDPOINT_GROUP

Local endpoint group (name or ID) with subnet(s) for IPsec connection

--peer-endpoint-group PEER_ENDPOINT_GROUP

Peer endpoint group (name or ID) with CIDR(s) for IPSec connection

--enable

Enable ipsec site connection

--disable

Disable ipsec site connection

--local-id LOCAL_ID

An id to be used instead of the external ip address for a virtual router

--peer-id PEER_ID

Peer router identity for authentication. can be IPv4/IPv6 address, e-mail address, key id, or FQDN

--peer-address PEER_ADDRESS

Peer gateway public IPv4/IPv6 address or FQDN

--psk PSK

Pre-shared key string.

--vpnservice VPNSERVICE

VPN service instance associated with this connection (name or ID)

--ikepolicy IKEPOLICY

IKE policy associated with this connection (name or ID)

--ipsecpolicy IPSECPOLICY

IPsec policy associated with this connection (name or ID)

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

Expand
Table 77.66. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 77.67. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.68. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.69. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

77.17. vpn ipsec site connection delete

Usage:

openstack vpn ipsec site connection delete [-h]

                                                <ipsec-site-connection>
                                                [<ipsec-site-connection> ...]
Copy to Clipboard Toggle word wrap

Delete IPsec site connection(s)

Expand
Table 77.70. Positional Arguments
ValueSummary

<ipsec-site-connection>

IPsec site connection to delete (name or ID)

Expand
Table 77.71. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-neutronclient plugin.

77.18. vpn ipsec site connection list

Usage:

openstack vpn ipsec site connection list [-h]

                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              [--long]
Copy to Clipboard Toggle word wrap

List IPsec site connections that belong to a given project

Expand
Table 77.72. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 77.73. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 77.74. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.75. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.76. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-neutronclient plugin.

77.19. vpn ipsec site connection set

Usage:

openstack vpn ipsec site connection set [-h]

                                             [--description <description>]
                                             [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
                                             [--mtu MTU]
                                             [--initiator {bi-directional,response-only}]
                                             [--peer-cidr PEER_CIDRS | --local-endpoint-group LOCAL_ENDPOINT_GROUP]
                                             [--peer-endpoint-group PEER_ENDPOINT_GROUP]
                                             [--enable | --disable]
                                             [--local-id LOCAL_ID]
                                             [--peer-id PEER_ID]
                                             [--peer-address PEER_ADDRESS]
                                             [--name <name>]
                                             <ipsec-site-connection>
Copy to Clipboard Toggle word wrap

Set IPsec site connection properties

Expand
Table 77.77. Positional Arguments
ValueSummary

<ipsec-site-connection>

IPsec site connection to set (name or ID)

Expand
Table 77.78. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the connection

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

--mtu MTU

Mtu size for the connection

--initiator {bi-directional,response-only}

Initiator state

--peer-cidr PEER_CIDRS

Remote subnet(s) in CIDR format. Cannot be specified when using endpoint groups. Only applicable, if subnet provided for VPN service.

--local-endpoint-group LOCAL_ENDPOINT_GROUP

Local endpoint group (name or ID) with subnet(s) for IPsec connection

--peer-endpoint-group PEER_ENDPOINT_GROUP

Peer endpoint group (name or ID) with CIDR(s) for IPSec connection

--enable

Enable ipsec site connection

--disable

Disable ipsec site connection

--local-id LOCAL_ID

An id to be used instead of the external ip address for a virtual router

--peer-id PEER_ID

Peer router identity for authentication. can be IPv4/IPv6 address, e-mail address, key id, or FQDN

--peer-address PEER_ADDRESS

Peer gateway public IPv4/IPv6 address or FQDN

--name <name>

Set friendly name for the connection

This command is provided by the python-neutronclient plugin.

77.20. vpn ipsec site connection show

Usage:

openstack vpn ipsec site connection show [-h]

                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              <ipsec-site-connection>
Copy to Clipboard Toggle word wrap

Show information of a given IPsec site connection

Expand
Table 77.79. Positional Arguments
ValueSummary

<ipsec-site-connection>

IPsec site connection to display (name or ID)

Expand
Table 77.80. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 77.81. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 77.82. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.83. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.84. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

77.21. vpn service create

Usage:

openstack vpn service create [-h] [-f {json,shell,table,value,yaml}]

                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  [--description <description>]
                                  [--subnet <subnet>] [--flavor <flavor>]
                                  [--enable | --disable] --router ROUTER
                                  [--project <project>]
                                  [--project-domain <project-domain>]
                                  <name>
Copy to Clipboard Toggle word wrap

Create an VPN service

Expand
Table 77.85. Positional Arguments
ValueSummary

<name>

Name for the vpn service

Expand
Table 77.86. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the VPN service

--subnet <subnet>

Local private subnet (name or id)

--flavor <flavor>

Flavor for the vpn service (name or id)

--enable

Enable vpn service

--disable

Disable vpn service

--router ROUTER

Router for the vpn service (name or id)

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

Expand
Table 77.87. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 77.88. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.89. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.90. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

77.22. vpn service delete

Usage:

openstack vpn service delete [-h] <vpn-service> [<vpn-service> ...]
Copy to Clipboard Toggle word wrap

Delete VPN service(s)

Expand
Table 77.91. Positional Arguments
ValueSummary

<vpn-service>

Vpn service to delete (name or id)

Expand
Table 77.92. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-neutronclient plugin.

77.23. vpn service list

Usage:

openstack vpn service list [-h] [-f {csv,json,table,value,yaml}]

                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--sort-column SORT_COLUMN] [--long]
Copy to Clipboard Toggle word wrap

List VPN services that belong to a given project

Expand
Table 77.93. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 77.94. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 77.95. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.96. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.97. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-neutronclient plugin.

77.24. vpn service set

Usage:

openstack vpn service set [-h] [--description <description>]

                               [--subnet <subnet>] [--flavor <flavor>]
                               [--enable | --disable] [--name <name>]
                               <vpn-service>
Copy to Clipboard Toggle word wrap

Set VPN service properties

Expand
Table 77.98. Positional Arguments
ValueSummary

<vpn-service>

Vpn service to modify (name or id)

Expand
Table 77.99. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the VPN service

--subnet <subnet>

Local private subnet (name or id)

--flavor <flavor>

Flavor for the vpn service (name or id)

--enable

Enable vpn service

--disable

Disable vpn service

--name <name>

Name for the vpn service

This command is provided by the python-neutronclient plugin.

77.25. vpn service show

Usage:

openstack vpn service show [-h] [-f {json,shell,table,value,yaml}]

                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                <vpn-service>
Copy to Clipboard Toggle word wrap

Display VPN service details

Expand
Table 77.100. Positional Arguments
ValueSummary

<vpn-service>

Vpn service to display (name or id)

Expand
Table 77.101. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 77.102. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 77.103. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 77.104. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 77.105. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat