BGP Dynamic Routing¶

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

bgp speaker create¶

Create a BGP speaker

openstack bgp speaker create
    [-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>

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

--local-as <local-as>¶: Local AS number. (Integer in [1, 4294967295] 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.

bgp speaker delete¶

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.

bgp speaker list¶

List BGP speakers

openstack bgp speaker list
    [-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]
    [--sort-ascending | --sort-descending]
    [--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 to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--agent <agent-id>¶: List BGP speakers hosted by an agent (ID only)

This command is provided by the python-neutronclient plugin.

bgp speaker set¶

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>¶: New name for the BGP speaker

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

bgp speaker show¶

Show a BGP speaker

openstack bgp speaker show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <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 to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

bgp-speaker¶: BGP speaker to display (name or ID)

This command is provided by the python-neutronclient plugin.

bgp speaker show dragents¶

(Deprecated) List dynamic routing agents hosting a BGP speaker

(Use “bgp dragent list” instead)

openstack bgp speaker show dragents
    [-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]
    [--sort-ascending | --sort-descending]
    <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 to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

bgp-speaker¶: List dynamic routing agents hosting a BGP speaker (name or ID)

This command is provided by the python-neutronclient plugin.

bgp speaker add network¶

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.

bgp speaker remove network¶

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.

bgp speaker add peer¶

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.

bgp speaker remove peer¶

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.

bgp speaker list advertised routes¶

List routes advertised

openstack bgp speaker list advertised routes
    [-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]
    [--sort-ascending | --sort-descending]
    <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 to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

bgp-speaker¶: BGP speaker (name or ID)

This command is provided by the python-neutronclient plugin.

bgp peer create¶

Create a BGP peer

openstack bgp peer create
    [-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>

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

--peer-ip <peer-ip-address>¶: Peer IP address

--remote-as <peer-remote-as>¶: Peer AS number. (Integer in [1, 4294967295] 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.

bgp peer delete¶

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.

bgp peer list¶

List BGP peers

openstack bgp peer list
    [-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]
    [--sort-ascending | --sort-descending]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the python-neutronclient plugin.

bgp peer set¶

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.

bgp peer show¶

Show information for a BGP peer

openstack bgp peer show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <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 to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

bgp-peer¶: BGP peer to display (name or ID)

This command is provided by the python-neutronclient plugin.

bgp dragent add speaker¶

Add a BGP speaker to a dynamic routing agent

openstack bgp dragent add speaker <agent-id> <bgp-speaker>

agent-id¶: ID of the dynamic routing agent

bgp-speaker¶: ID or name of the BGP speaker

This command is provided by the python-neutronclient plugin.

bgp dragent list¶

List dynamic routing agents

openstack bgp dragent list
    [-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]
    [--sort-ascending | --sort-descending]
    [--bgp-speaker <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 to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--bgp-speaker <bgp-speaker>¶: List dynamic routing agents hosting a BGP speaker (name or ID)

This command is provided by the python-neutronclient plugin.

bgp dragent remove speaker¶

Removes a BGP speaker from a dynamic routing agent

openstack bgp dragent remove speaker <agent-id> <bgp-speaker>

agent-id¶: ID of the dynamic routing agent

bgp-speaker¶: ID or name of the BGP speaker

This command is provided by the python-neutronclient plugin.

BGP Dynamic Routing

BGP Dynamic Routing¶

bgp speaker create¶

bgp speaker delete¶

bgp speaker list¶

bgp speaker set¶

bgp speaker show¶

bgp speaker show dragents¶

bgp speaker add network¶

bgp speaker remove network¶

bgp speaker add peer¶

bgp speaker remove peer¶

bgp speaker list advertised routes¶

bgp peer create¶

bgp peer delete¶

bgp peer list¶

bgp peer set¶

bgp peer show¶

bgp dragent add speaker¶

bgp dragent list¶

bgp dragent remove speaker¶

python-neutronclient 8.1.1.dev3

Page Contents