BGP dynamic routing enables announcement of project subnet prefixes via BGP. Admins create BGP speakers and BGP peers. BGP peers can be associated with BGP speakers, thereby enabling peering sessions with operator infrastructure. BGP speakers can be associated with networks, which controls which routes are announced to peers.
Network v2
Create a BGP speaker
openstack bgp speaker create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
--local
-a
s
<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>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--local-as
<local-as>
¶Local AS number. (Integer in [1, 65535] is allowed.)
--ip-version
<IP_VERSION>
¶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.
name
¶Name of the BGP speaker to create
This command is provided by the python-neutronclient plugin.
Delete a BGP speaker
openstack bgp speaker delete <bgp-speaker>
bgp-speaker
¶BGP speaker to delete (name or ID)
This command is provided by the python-neutronclient plugin.
List BGP speakers
openstack bgp speaker list
[-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>]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--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
--agent
<agent-id>
¶List BGP speakers hosted by an agent (ID only)
This command is provided by the python-neutronclient plugin.
Set BGP speaker properties
openstack bgp speaker set
[--name NAME]
[--advertise-floating-ip-host-routes]
[--no-advertise-floating-ip-host-routes]
[--advertise-tenant-networks]
[--no-advertise-tenant-networks]
<bgp-speaker>
--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.
bgp-speaker
¶BGP speaker to update (name or ID)
This command is provided by the python-neutronclient plugin.
Show a BGP speaker
openstack bgp speaker show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
<bgp-speaker>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
bgp-speaker
¶BGP speaker to display (name or ID)
This command is provided by the python-neutronclient plugin.
List dynamic routing agents hosting a BGP speaker
openstack bgp speaker show dragents
[-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>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--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
bgp-speaker
¶ID or name of the BGP speaker
This command is provided by the python-neutronclient plugin.
Add a network to a BGP speaker
openstack bgp speaker add network <bgp-speaker> <network>
bgp-speaker
¶BGP speaker (name or ID)
network
¶Network to add (name or ID)
This command is provided by the python-neutronclient plugin.
Remove a network from a BGP speaker
openstack bgp speaker remove network <bgp-speaker> <network>
bgp-speaker
¶BGP speaker (name or ID)
network
¶Network to remove (name or ID)
This command is provided by the python-neutronclient plugin.
Add a peer to a BGP speaker
openstack bgp speaker add peer <bgp-speaker> <bgp-peer>
bgp-speaker
¶BGP speaker (name or ID)
bgp-peer
¶BGP Peer to add (name or ID)
This command is provided by the python-neutronclient plugin.
Remove a peer from a BGP speaker
openstack bgp speaker remove peer <bgp-speaker> <bgp-peer>
bgp-speaker
¶BGP speaker (name or ID)
bgp-peer
¶BGP Peer to remove (name or ID)
This command is provided by the python-neutronclient plugin.
List routes advertised
openstack bgp speaker list advertised routes
[-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>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--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
bgp-speaker
¶BGP speaker (name or ID)
This command is provided by the python-neutronclient plugin.
Create a BGP peer
openstack bgp peer create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
--peer
-i
p
<peer-ip-address>
--remote
-a
s
<peer-remote-as>
[--auth-type <peer-auth-type>]
[--password <auth-password>]
[--project <project>]
[--project-domain <project-domain>]
<name>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--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.
name
¶Name of the BGP peer to create
This command is provided by the python-neutronclient plugin.
Delete a BGP peer
openstack bgp peer delete <bgp-peer>
bgp-peer
¶BGP peer to delete (name or ID)
This command is provided by the python-neutronclient plugin.
List BGP peers
openstack bgp peer list
[-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]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--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
This command is provided by the python-neutronclient plugin.
Update a BGP peer
openstack bgp peer set
[--name NAME]
[--password <auth-password>]
<bgp-peer>
--name
<NAME>
¶Updated name of the BGP peer
--password
<auth-password>
¶Updated authentication password
bgp-peer
¶BGP peer to update (name or ID)
This command is provided by the python-neutronclient plugin.
Show information for a BGP peer
openstack bgp peer show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
<bgp-peer>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
bgp-peer
¶BGP peer to display (name or ID)
This command is provided by the python-neutronclient plugin.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.