Chapter 13. bgpvpn

This chapter describes the commands under the bgpvpn command.

13.1. bgpvpn create

Create BGP VPN resource

Usage:

openstack bgpvpn create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--project <project>]
                               [--project-domain <project-domain>]
                               [--name <name>] [--route-target <route-target>]
                               [--import-target <import-target>]
                               [--export-target <export-target>]
                               [--route-distinguisher <route-distinguisher>]
                               [--vni VNI] [--local-pref LOCAL_PREF]
                               [--type {l2,l3}]

Table 13.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--name <name>

Name of the bgp vpn

--route-target <route-target>

Add route target to import/export list (repeat option for multiple Route Targets)

--import-target <import-target>

Add route target to import list (repeat option for multiple Route Targets)

--export-target <export-target>

Add route target to export list (repeat option for multiple Route Targets)

--route-distinguisher <route-distinguisher>

Add route distinguisher to the list of route Distinguishers from which a Route Distinguishers will be picked from to advertise a VPN route (repeat option for multiple Route Distinguishers)

--vni VNI

Vxlan network identifier to be used for this bgpvpn when a VXLAN encapsulation is used

--local-pref LOCAL_PREF

Default bgp local_pref to use in route advertisementstowards this BGPVPN.

--type {l2,l3}

Bgp vpn type selection between ip vpn (l3) and Ethernet VPN (l2) (default: l3)

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

Table 13.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.4. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

13.2. bgpvpn delete

Delete BGP VPN resource(s)

Usage:

openstack bgpvpn delete [-h] <bgpvpn> [<bgpvpn> ...]

Table 13.6. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn(s) to delete (name or id)

Table 13.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

13.3. bgpvpn list

List BGP VPN resources

Usage:

openstack bgpvpn list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--project <project>]
                             [--project-domain <project-domain>] [--long]
                             [--property <key=value>]

Table 13.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

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

Table 13.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 13.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

13.4. bgpvpn network association create

Create a BGP VPN network association

Usage:

openstack bgpvpn network association create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--project <project>]
                                                   [--project-domain <project-domain>]
                                                   <bgpvpn> <network>

Table 13.13. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to apply the network association (name or id)

<network>

Network to associate the bgp vpn (name or id)

Table 13.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

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

Table 13.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.17. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

13.5. bgpvpn network association delete

Delete a BGP VPN network association(s) for a given BGP VPN

Usage:

openstack bgpvpn network association delete [-h]
                                                   <network association ID>
                                                   [<network association ID> ...]
                                                   <bgpvpn>

Table 13.19. Positional Arguments

ValueSummary

<network association ID>

Network association id(s) to remove

<bgpvpn>

Bgp vpn the network association belongs to (name or ID)

Table 13.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

13.6. bgpvpn network association list

List BGP VPN network associations for a given BGP VPN

Usage:

openstack bgpvpn network association list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]
                                                 [--long]
                                                 [--property <key=value>]
                                                 <bgpvpn>

Table 13.21. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn listed associations belong to (name or id)

Table 13.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

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

Table 13.24. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 13.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

13.7. bgpvpn network association show

Show information of a given BGP VPN network association

Usage:

openstack bgpvpn network association show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <network association ID>
                                                 <bgpvpn>

Table 13.27. Positional Arguments

ValueSummary

<network association ID>

Network association id to look up

<bgpvpn>

Bgp vpn the association belongs to (name or id)

Table 13.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 13.30. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.31. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

13.8. bgpvpn port association create

Create a BGP VPN port association

Usage:

openstack bgpvpn port association create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--project <project>]
                                                [--project-domain <project-domain>]
                                                [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                                [--prefix-route prefix=<cidr>[,local_pref=<integer>]]
                                                [--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]]
                                                <bgpvpn> <port>

Table 13.33. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to apply the port association (name or id)

<port>

Port to associate the bgp vpn (name or id)

Table 13.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--advertise-fixed-ips

Fixed ips of the port will be advertised to the bgp VPN (default)

--no-advertise-fixed-ips

Fixed ips of the port will not be advertised to the BGP VPN

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Add prefix route in cidr notation. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple prefix routes)

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

Add bgp vpn route for route leaking. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple BGP VPN routes)

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

Table 13.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.37. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

13.9. bgpvpn port association delete

Delete a BGP VPN port association(s) for a given BGP VPN

Usage:

openstack bgpvpn port association delete [-h]
                                                <port association ID>
                                                [<port association ID> ...]
                                                <bgpvpn>

Table 13.39. Positional Arguments

ValueSummary

<port association ID>

Port association id(s) to remove

<bgpvpn>

Bgp vpn the port association belongs to (name or id)

Table 13.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

13.10. bgpvpn port association list

List BGP VPN port associations for a given BGP VPN

Usage:

openstack bgpvpn port association list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--long]
                                              [--property <key=value>]
                                              <bgpvpn>

Table 13.41. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn listed associations belong to (name or id)

Table 13.42. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

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

Table 13.44. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 13.45. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

13.11. bgpvpn port association set

Set BGP VPN port association properties

Usage:

openstack bgpvpn port association set [-h]
                                             [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                             [--prefix-route prefix=<cidr>[,local_pref=<integer>]]
                                             [--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]]
                                             [--no-prefix-route]
                                             [--no-bgpvpn-route]
                                             <port association ID> <bgpvpn>

Table 13.47. Positional Arguments

ValueSummary

<port association ID>

Port association id to update

<bgpvpn>

Bgp vpn the port association belongs to (name or id)

Table 13.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--advertise-fixed-ips

Fixed ips of the port will be advertised to the bgp VPN

--no-advertise-fixed-ips

Fixed ips of the port will not be advertised to the BGP VPN

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Add prefix route in cidr notation. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple prefix routes)

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

Add bgp vpn route for route leaking. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple BGP VPN routes)

--no-prefix-route

Empty prefix route list

--no-bgpvpn-route

Empty bgp vpn route list

13.12. bgpvpn port association show

Show information of a given BGP VPN port association

Usage:

openstack bgpvpn port association show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <port association ID> <bgpvpn>

Table 13.49. Positional Arguments

ValueSummary

<port association ID>

Port association id to look up

<bgpvpn>

Bgp vpn the association belongs to (name or id)

Table 13.50. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 13.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.53. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

13.13. bgpvpn port association unset

Unset BGP VPN port association properties

Usage:

openstack bgpvpn port association unset [-h]
                                               [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                               [--prefix-route <cidr>]
                                               [--bgpvpn-route <BGP VPN ID or name>]
                                               [--all-prefix-routes]
                                               [--all-bgpvpn-routes]
                                               <port association ID> <bgpvpn>

Table 13.55. Positional Arguments

ValueSummary

<port association ID>

Port association id to update

<bgpvpn>

Bgp vpn the port association belongs to (name or id)

Table 13.56. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--advertise-fixed-ips

Fixed ips of the port will not be advertised to the BGP VPN

--no-advertise-fixed-ips

Fixed ips of the port will be advertised to the bgp VPN

--prefix-route <cidr>

Remove prefix route in cidr notation (repeat option for multiple prefix routes)

--bgpvpn-route <BGP VPN ID or name>

Remove bgp vpn route (repeat option for multiple bgp VPN routes)

--all-prefix-routes

Empty prefix route list

--all-bgpvpn-routes

Empty bgp vpn route list

13.14. bgpvpn router association create

Create a BGP VPN router association

Usage:

openstack bgpvpn router association create [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--project <project>]
                                                  [--project-domain <project-domain>]
                                                  [--advertise_extra_routes | --no-advertise_extra_routes]
                                                  <bgpvpn> <router>

Table 13.57. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to apply the router association (name or id)

<router>

Router to associate the bgp vpn (name or id)

Table 13.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--advertise_extra_routes

Routes will be advertised to the bgp vpn (default)

--no-advertise_extra_routes

Routes from the router will not be advertised to the BGP VPN

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

Table 13.60. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.61. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

13.15. bgpvpn router association delete

Delete a BGP VPN router association(s) for a given BGP VPN

Usage:

openstack bgpvpn router association delete [-h]
                                                  <router association ID>
                                                  [<router association ID> ...]
                                                  <bgpvpn>

Table 13.63. Positional Arguments

ValueSummary

<router association ID>

Router association id(s) to remove

<bgpvpn>

Bgp vpn the router association belongs to (name or id)

Table 13.64. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

13.16. bgpvpn router association list

List BGP VPN router associations for a given BGP VPN

Usage:

openstack bgpvpn router association list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                [--long]
                                                [--property <key=value>]
                                                <bgpvpn>

Table 13.65. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn listed associations belong to (name or id)

Table 13.66. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

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

Table 13.68. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 13.69. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

13.17. bgpvpn router association set

Set BGP VPN router association properties

Usage:

openstack bgpvpn router association set [-h]
                                               [--advertise_extra_routes | --no-advertise_extra_routes]
                                               <router association ID>
                                               <bgpvpn>

Table 13.71. Positional Arguments

ValueSummary

<router association ID>

Router association id to update

<bgpvpn>

Bgp vpn the router association belongs to (name or id)

Table 13.72. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--advertise_extra_routes

Routes will be advertised to the bgp vpn

--no-advertise_extra_routes

Routes from the router will not be advertised to the BGP VPN

13.18. bgpvpn router association show

Show information of a given BGP VPN router association

Usage:

openstack bgpvpn router association show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                <router association ID>
                                                <bgpvpn>

Table 13.73. Positional Arguments

ValueSummary

<router association ID>

Router association id to look up

<bgpvpn>

Bgp vpn the association belongs to (name or id)

Table 13.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 13.76. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.77. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

13.19. bgpvpn router association unset

Unset BGP VPN router association properties

Usage:

openstack bgpvpn router association unset [-h]
                                                 [--advertise_extra_routes | --no-advertise_extra_routes]
                                                 <router association ID>
                                                 <bgpvpn>

Table 13.79. Positional Arguments

ValueSummary

<router association ID>

Router association id to update

<bgpvpn>

Bgp vpn the router association belongs to (name or id)

Table 13.80. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--advertise_extra_routes

Routes from the router will not be advertised to the BGP VPN

--no-advertise_extra_routes

Routes will be advertised to the bgp vpn

13.20. bgpvpn set

Set BGP VPN properties

Usage:

openstack bgpvpn set [-h] [--name <name>]
                            [--route-target <route-target>]
                            [--no-route-target]
                            [--import-target <import-target>]
                            [--no-import-target]
                            [--export-target <export-target>]
                            [--no-export-target]
                            [--route-distinguisher <route-distinguisher>]
                            [--no-route-distinguisher] [--vni VNI]
                            [--local-pref LOCAL_PREF]
                            <bgpvpn>

Table 13.81. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to update (name or id)

Table 13.82. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the bgp vpn

--route-target <route-target>

Add route target to import/export list (repeat option for multiple Route Targets)

--no-route-target

Empty route target list

--import-target <import-target>

Add route target to import list (repeat option for multiple Route Targets)

--no-import-target

Empty import route target list

--export-target <export-target>

Add route target to export list (repeat option for multiple Route Targets)

--no-export-target

Empty export route target list

--route-distinguisher <route-distinguisher>

Add route distinguisher to the list of route Distinguishers from which a Route Distinguishers will be picked from to advertise a VPN route (repeat option for multiple Route Distinguishers)

--no-route-distinguisher

Empty route distinguisher list

--vni VNI

Vxlan network identifier to be used for this bgpvpn when a VXLAN encapsulation is used

--local-pref LOCAL_PREF

Default bgp local_pref to use in route advertisementstowards this BGPVPN.

13.21. bgpvpn show

Show information of a given BGP VPN

Usage:

openstack bgpvpn show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <bgpvpn>

Table 13.83. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to display (name or id)

Table 13.84. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 13.86. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.87. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

13.22. bgpvpn unset

Unset BGP VPN properties

Usage:

openstack bgpvpn unset [-h] [--route-target <route-target>]
                              [--all-route-target]
                              [--import-target <import-target>]
                              [--all-import-target]
                              [--export-target <export-target>]
                              [--all-export-target]
                              [--route-distinguisher <route-distinguisher>]
                              [--all-route-distinguisher] [--vni VNI]
                              [--local-pref LOCAL_PREF]
                              <bgpvpn>

Table 13.89. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to update (name or id)

Table 13.90. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--route-target <route-target>

Remove route target from import/export list (repeat option for multiple Route Targets)

--all-route-target

Empty route target list

--import-target <import-target>

Remove route target from import list (repeat option for multiple Route Targets)

--all-import-target

Empty import route target list

--export-target <export-target>

Remove route target from export list (repeat option for multiple Route Targets)

--all-export-target

Empty export route target list

--route-distinguisher <route-distinguisher>

Remove route distinguisher from the list of route Distinguishers from which a Route Distinguishers will be picked from to advertise a VPN route (repeat option for multiple Route Distinguishers)

--all-route-distinguisher

Empty route distinguisher list

--vni VNI

Vxlan network identifier to be used for this bgpvpn when a VXLAN encapsulation is used

--local-pref LOCAL_PREF

Default bgp local_pref to use in route advertisementstowards this BGPVPN.