Chapter 10. bgp
This chapter describes the commands under the bgp
command.
10.1. bgp dragent add speaker
Add a BGP speaker to a dynamic routing agent
Usage:
openstack bgp dragent add speaker [-h] <agent-id> <bgp-speaker>
Table 10.1. Positional Arguments
Value | Summary |
---|---|
<agent-id> | Id of the dynamic routing agent |
<bgp-speaker> | Id or name of the bgp speaker |
Table 10.2. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.2. bgp dragent remove speaker
Removes a BGP speaker from a dynamic routing agent
Usage:
openstack bgp dragent remove speaker [-h] <agent-id> <bgp-speaker>
Table 10.3. Positional Arguments
Value | Summary |
---|---|
<agent-id> | Id of the dynamic routing agent |
<bgp-speaker> | Id or name of the bgp speaker |
Table 10.4. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.3. bgp peer create
Create a BGP peer
Usage:
openstack bgp peer create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] --peer-ip <peer-ip-address> --remote-as <peer-remote-as> [--auth-type <peer-auth-type>] [--password <auth-password>] [--project <project>] [--project-domain <project-domain>] <name>
Table 10.5. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 10.6. Positional Arguments
Value | Summary |
---|---|
<name> | Name of the bgp peer to create |
Table 10.7. Output Formatters
Value | Summary |
---|---|
output formatter options-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 10.8. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 10.9. Optional Arguments
Value | Summary |
---|---|
--remote-as <peer-remote-as> | Peer as number. (integer in [1, 65535] is allowed) |
--auth-type <peer-auth-type> | Authentication algorithm. supported algorithms: none (default), md5 |
--peer-ip <peer-ip-address> | Peer ip address |
--project-domain <project-domain> | Domain the project belongs to (name or id). this can be used in case collisions between project names exist. |
--password <auth-password> | Authentication password |
-h, --help | Show this help message and exit |
--project <project> | Owner’s project (name or id) |
Table 10.10. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
10.4. bgp peer delete
Delete a BGP peer
Usage:
openstack bgp peer delete [-h] <bgp-peer>
Table 10.11. Positional Arguments
Value | Summary |
---|---|
<bgp-peer> | Bgp peer to delete (name or id) |
Table 10.12. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.5. bgp peer list
List BGP peers
Usage:
openstack bgp peer 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]
Table 10.13. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 10.14. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 10.15. Output Formatters
Value | Summary |
---|---|
output formatter options-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 10.16. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 10.17. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.6. bgp peer set
Update a BGP peer
Usage:
openstack bgp peer set [-h] [--name NAME] [--password <auth-password>] <bgp-peer>
Table 10.18. Positional Arguments
Value | Summary |
---|---|
<bgp-peer> | Bgp peer to update (name or id) |
Table 10.19. Optional Arguments
Value | Summary |
---|---|
--password <auth-password> | Updated authentication password |
-h, --help | Show this help message and exit |
--name NAME | Updated name of the bgp peer |
10.7. bgp peer show
Show information for a BGP peer
Usage:
openstack bgp peer show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] <bgp-peer>
Table 10.20. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 10.21. Positional Arguments
Value | Summary |
---|---|
<bgp-peer> | Bgp peer to display (name or id) |
Table 10.22. Output Formatters
Value | Summary |
---|---|
output formatter options-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 10.23. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 10.24. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 10.25. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
10.8. bgp speaker add network
Add a network to a BGP speaker
Usage:
openstack bgp speaker add network [-h] <bgp-speaker> <network>
Table 10.26. Positional Arguments
Value | Summary |
---|---|
<bgp-speaker> | Bgp speaker (name or id) |
<network> | Network to add (name or id) |
Table 10.27. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.9. bgp speaker add peer
Add a peer to a BGP speaker
Usage:
openstack bgp speaker add peer [-h] <bgp-speaker> <bgp-peer>
Table 10.28. Positional Arguments
Value | Summary |
---|---|
<bgp-peer> | Bgp peer to add (name or id) |
<bgp-speaker> | Bgp speaker (name or id) |
Table 10.29. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.10. bgp speaker create
Create a BGP speaker
Usage:
openstack bgp speaker create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] --local-as <local-as> [--ip-version {4,6}] [--advertise-floating-ip-host-routes] [--no-advertise-floating-ip-host-routes] [--advertise-tenant-networks] [--no-advertise-tenant-networks] [--project <project>] [--project-domain <project-domain>] <name>
Table 10.30. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 10.31. Positional Arguments
Value | Summary |
---|---|
<name> | Name of the bgp speaker to create |
Table 10.32. Output Formatters
Value | Summary |
---|---|
output formatter options-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 10.33. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 10.34. Optional Arguments
Value | Summary |
---|---|
--no-advertise-floating-ip-host-routes | Disable the advertisement of floating ip host routes by the BGP speaker. |
--project-domain <project-domain> | Domain the project belongs to (name or id). this can be used in case collisions between project names exist. |
--no-advertise-tenant-networks | Disable the advertisement of tenant network routes by the BGP speaker. |
--ip-version {4,6} | Ip version for the bgp speaker (default is 4) |
--advertise-floating-ip-host-routes | Enable the advertisement of floating ip host routes by the BGP speaker. (default) |
--local-as <local-as> | Local as number. (integer in [1, 65535] is allowed.) |
--advertise-tenant-networks | Enable the advertisement of tenant network routes by the BGP speaker. (default) |
-h, --help | Show this help message and exit |
--project <project> | Owner’s project (name or id) |
Table 10.35. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
10.11. bgp speaker delete
Delete a BGP speaker
Usage:
openstack bgp speaker delete [-h] <bgp-speaker>
Table 10.36. Positional Arguments
Value | Summary |
---|---|
<bgp-speaker> | Bgp speaker to delete (name or id) |
Table 10.37. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.12. bgp speaker list advertised routes
List routes advertised
Usage:
openstack bgp speaker list advertised routes [-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] <bgp-speaker>
Table 10.38. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 10.39. Positional Arguments
Value | Summary |
---|---|
<bgp-speaker> | Bgp speaker (name or id) |
Table 10.40. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 10.41. Output Formatters
Value | Summary |
---|---|
output formatter options-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 10.42. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 10.43. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.13. bgp speaker list
List BGP speakers
Usage:
openstack bgp speaker 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] [--agent <agent-id>]
Table 10.44. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 10.45. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 10.46. Output Formatters
Value | Summary |
---|---|
output formatter options-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 10.47. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 10.48. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--agent <agent-id> | List bgp speakers hosted by an agent (id only) |
10.14. bgp speaker remove network
Remove a network from a BGP speaker
Usage:
openstack bgp speaker remove network [-h] <bgp-speaker> <network>
Table 10.49. Positional Arguments
Value | Summary |
---|---|
<bgp-speaker> | Bgp speaker (name or id) |
<network> | Network to remove (name or id) |
Table 10.50. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.15. bgp speaker remove peer
Remove a peer from a BGP speaker
Usage:
openstack bgp speaker remove peer [-h] <bgp-speaker> <bgp-peer>
Table 10.51. Positional Arguments
Value | Summary |
---|---|
<bgp-peer> | Bgp peer to remove (name or id) |
<bgp-speaker> | Bgp speaker (name or id) |
Table 10.52. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.16. bgp speaker set
Set BGP speaker properties
Usage:
openstack bgp speaker set [-h] [--name NAME] [--advertise-floating-ip-host-routes] [--no-advertise-floating-ip-host-routes] [--advertise-tenant-networks] [--no-advertise-tenant-networks] <bgp-speaker>
Table 10.53. Positional Arguments
Value | Summary |
---|---|
<bgp-speaker> | Bgp speaker to update (name or id) |
Table 10.54. Optional Arguments
Value | Summary |
---|---|
--no-advertise-floating-ip-host-routes | Disable the advertisement of floating ip host routes by the BGP speaker. |
--no-advertise-tenant-networks | Disable the advertisement of tenant network routes by the BGP speaker. |
--advertise-floating-ip-host-routes | Enable the advertisement of floating ip host routes by the BGP speaker. (default) |
--name NAME | Name of the bgp speaker to update |
--advertise-tenant-networks | Enable the advertisement of tenant network routes by the BGP speaker. (default) |
-h, --help | Show this help message and exit |
10.17. bgp speaker show dragents
List dynamic routing agents hosting a BGP speaker
Usage:
openstack bgp speaker show dragents [-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] <bgp-speaker>
Table 10.55. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 10.56. Positional Arguments
Value | Summary |
---|---|
<bgp-speaker> | Id or name of the bgp speaker |
Table 10.57. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 10.58. Output Formatters
Value | Summary |
---|---|
output formatter options-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 10.59. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 10.60. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
10.18. bgp speaker show
Show a BGP speaker
Usage:
openstack bgp speaker show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] <bgp-speaker>
Table 10.61. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 10.62. Positional Arguments
Value | Summary |
---|---|
<bgp-speaker> | Bgp speaker to display (name or id) |
Table 10.63. Output Formatters
Value | Summary |
---|---|
output formatter options-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 10.64. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 10.65. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 10.66. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |