Language:
Format:

Language:
Format:

Chapter 12. bgp

This chapter describes the commands under the bgp command.

12.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 12.1. Positional Arguments

Value	Summary
<agent-id>	Id of the dynamic routing agent
<bgp-speaker>	Id or name of the bgp speaker

Table 12.2. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

12.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 12.3. Positional Arguments

Value	Summary
<agent-id>	Id of the dynamic routing agent
<bgp-speaker>	Id or name of the bgp speaker

Table 12.4. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

12.3. bgp peer create

Create a BGP peer

Usage:

openstack bgp peer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] --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 12.5. Positional Arguments

Value	Summary
<name>	Name of the bgp peer to create

Table 12.6. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--peer-ip <peer-ip-address>	Peer ip address
--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
--password <auth-password>	Authentication password
--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 12.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 12.8. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 12.9. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

Table 12.10. Table Formatter

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

12.4. bgp peer delete

Delete a BGP peer

Usage:

openstack bgp peer delete [-h] <bgp-peer>

Table 12.11. Positional Arguments

Value	Summary
<bgp-peer>	Bgp peer to delete (name or id)

Table 12.12. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

12.5. bgp peer list

List BGP peers

Usage:

openstack bgp peer 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]

Table 12.13. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 12.14. 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 12.15. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 12.16. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 12.17. Table Formatter

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

12.6. bgp peer set

Update a BGP peer

Usage:

openstack bgp peer set [-h] [--name NAME] [--password <auth-password>]
                              <bgp-peer>

Table 12.18. Positional Arguments

Value	Summary
<bgp-peer>	Bgp peer to update (name or id)

Table 12.19. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--name NAME	Updated name of the bgp peer
--password <auth-password>	Updated authentication password

12.7. bgp peer show

Show information for a BGP peer

Usage:

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

Table 12.20. Positional Arguments

Value	Summary
<bgp-peer>	Bgp peer to display (name or id)

Table 12.21. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 12.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 12.23. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 12.24. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

Table 12.25. Table Formatter

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

12.8. bgp speaker add network

Add a network to a BGP speaker

Usage:

openstack bgp speaker add network [-h] <bgp-speaker> <network>

Table 12.26. Positional Arguments

Value	Summary
<bgp-speaker>	Bgp speaker (name or id)
<network>	Network to add (name or id)

Table 12.27. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

12.9. bgp speaker add peer

Add a peer to a BGP speaker

Usage:

openstack bgp speaker add peer [-h] <bgp-speaker> <bgp-peer>

Table 12.28. Positional Arguments

Value	Summary
<bgp-speaker>	Bgp speaker (name or id)
<bgp-peer>	Bgp peer to add (name or id)

Table 12.29. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

12.10. bgp speaker create

Create a BGP speaker

Usage:

openstack bgp speaker create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] --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 12.30. Positional Arguments

Value	Summary
<name>	Name of the bgp speaker to create

Table 12.31. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--local-as <local-as>	Local as number. (integer in [1, 65535] is allowed.)
--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)
--no-advertise-floating-ip-host-routes	Disable the advertisement of floating ip host routes by the BGP speaker.
--advertise-tenant-networks	Enable the advertisement of tenant network routes by the BGP speaker. (default)
--no-advertise-tenant-networks	Disable the advertisement of tenant network routes by the BGP speaker.
--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 12.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 12.33. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 12.34. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

Table 12.35. Table Formatter

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

12.11. bgp speaker delete

Delete a BGP speaker

Usage:

openstack bgp speaker delete [-h] <bgp-speaker>

Table 12.36. Positional Arguments

Value	Summary
<bgp-speaker>	Bgp speaker to delete (name or id)

Table 12.37. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

12.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]
                                                    [--quote {all,minimal,none,nonnumeric}]
                                                    [--noindent]
                                                    [--max-width <integer>]
                                                    [--fit-width]
                                                    [--print-empty]
                                                    [--sort-column SORT_COLUMN]
                                                    <bgp-speaker>

Table 12.38. Positional Arguments

Value	Summary
<bgp-speaker>	Bgp speaker (name or id)

Table 12.39. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 12.40. 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 12.41. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 12.42. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 12.43. Table Formatter

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

12.13. bgp speaker list

List BGP speakers

Usage:

openstack bgp speaker 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]
                                  [--agent <agent-id>]

Table 12.44. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--agent <agent-id>	List bgp speakers hosted by an agent (id only)

Table 12.45. 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 12.46. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 12.47. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 12.48. Table Formatter

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

12.14. bgp speaker remove network

Remove a network from a BGP speaker

Usage:

openstack bgp speaker remove network [-h] <bgp-speaker> <network>

Table 12.49. Positional Arguments

Value	Summary
<bgp-speaker>	Bgp speaker (name or id)
<network>	Network to remove (name or id)

Table 12.50. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

12.15. bgp speaker remove peer

Remove a peer from a BGP speaker

Usage:

openstack bgp speaker remove peer [-h] <bgp-speaker> <bgp-peer>

Table 12.51. Positional Arguments

Value	Summary
<bgp-speaker>	Bgp speaker (name or id)
<bgp-peer>	Bgp peer to remove (name or id)

Table 12.52. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

12.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 12.53. Positional Arguments

Value	Summary
<bgp-speaker>	Bgp speaker to update (name or id)

Table 12.54. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--name NAME	Name of the bgp speaker to update
--advertise-floating-ip-host-routes	Enable the advertisement of floating ip host routes by the BGP speaker. (default)
--no-advertise-floating-ip-host-routes	Disable the advertisement of floating ip host routes by the BGP speaker.
--advertise-tenant-networks	Enable the advertisement of tenant network routes by the BGP speaker. (default)
--no-advertise-tenant-networks	Disable the advertisement of tenant network routes by the BGP speaker.

12.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]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           <bgp-speaker>

Table 12.55. Positional Arguments

Value	Summary
<bgp-speaker>	Id or name of the bgp speaker

Table 12.56. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 12.57. 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 12.58. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 12.59. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 12.60. Table Formatter

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

12.18. bgp speaker show

Show a BGP speaker

Usage:

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

Table 12.61. Positional Arguments

Value	Summary
<bgp-speaker>	Bgp speaker to display (name or id)

Table 12.62. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 12.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 12.64. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 12.65. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

Table 12.66. Table Formatter

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

Select Your Language

Chapter 12. bgp

12.1. bgp dragent add speaker

12.2. bgp dragent remove speaker

12.3. bgp peer create

12.4. bgp peer delete

12.5. bgp peer list

12.6. bgp peer set

12.7. bgp peer show

12.8. bgp speaker add network

12.9. bgp speaker add peer

12.10. bgp speaker create

12.11. bgp speaker delete

12.12. bgp speaker list advertised routes

12.13. bgp speaker list

12.14. bgp speaker remove network

12.15. bgp speaker remove peer

12.16. bgp speaker set

12.17. bgp speaker show dragents

12.18. bgp speaker show

Quick Links

Help

Site Info

Related Sites

About

Red Hat legal and privacy links

Red Hat legal and privacy links

Language and Page Formatting Options

Chapter 12. bgp

12.1. bgp dragent add speaker

12.2. bgp dragent remove speaker

12.3. bgp peer create

12.4. bgp peer delete

12.5. bgp peer list

12.6. bgp peer set

12.7. bgp peer show

12.8. bgp speaker add network

12.9. bgp speaker add peer

12.10. bgp speaker create

12.11. bgp speaker delete

12.12. bgp speaker list advertised routes

12.13. bgp speaker list

12.14. bgp speaker remove network

12.15. bgp speaker remove peer

12.16. bgp speaker set

12.17. bgp speaker show dragents

12.18. bgp speaker show

Quick Links

Help

Site Info

Related Sites

Systems Status

About

Red Hat legal and privacy links

Red Hat legal and privacy links