A bgpvpn resource contains a set of parameters to define a BGP-based VPN. BGP-based IP VPNs networks are widely used in the industry especially for enterprises. The networking BGP VPN project aims at supporting inter-connection between L3VPNs and Neutron resources, i.e. Networks, Routers and Ports.
Network v2
Create BGP VPN resource
openstack bgpvpn create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
[--project <project>]
[--project-domain <project-domain>]
[--name <name>]
[--route-target <route-target>]
[--import-target <import-target>]
[--export-target <export-target>]
[--route-distinguisher <route-distinguisher>]
[--type {l2,l3}]
-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
--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)
--type
<TYPE>
¶BGP VPN type selection between IP VPN (l3) and Ethernet VPN (l2) (default: l3)
Delete BGP VPN resource(s)
openstack bgpvpn delete <bgpvpn> [<bgpvpn> ...]
bgpvpn
¶BGP VPN(s) to delete (name or ID)
List BGP VPN resources
openstack bgpvpn list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project <project>]
[--project-domain <project-domain>]
[--long]
[--property <key=value>]
-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
--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)
Set BGP VPN properties
openstack bgpvpn set
[--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]
<bgpvpn>
--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
bgpvpn
¶BGP VPN to update (name or ID)
Show information of a given BGP VPN
openstack bgpvpn show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
<bgpvpn>
-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
bgpvpn
¶BGP VPN to display (name or ID)
Unset BGP VPN properties
openstack bgpvpn unset
[--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]
<bgpvpn>
--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
bgpvpn
¶BGP VPN to update (name or ID)
Create a BGP VPN network association
openstack bgpvpn network association create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
[--project <project>]
[--project-domain <project-domain>]
<bgpvpn>
<network>
-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
--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.
bgpvpn
¶BGP VPN to apply the network association (name or ID)
network
¶Network to associate the BGP VPN (name or ID)
Delete a BGP VPN network association(s) for a given BGP VPN
openstack bgpvpn network association delete
<network
association
ID>
[<network association ID> ...]
<bgpvpn>
network
association ID
¶Network association ID(s) to remove
bgpvpn
¶BGP VPN the association belongs to (name or ID)
List BGP VPN network associations for a given BGP VPN
openstack bgpvpn network association list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
<bgpvpn>
-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
--long
¶List additional fields in output
bgpvpn
¶BGP VPN listed associations belong to (name or ID)
Show information of a given BGP VPN network association
openstack bgpvpn network association show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
<network
association
ID>
<bgpvpn>
-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
network
association ID
¶Network association ID to look up
bgpvpn
¶BGP VPN the association belongs to (name or ID)
Create a BGP VPN router association
openstack bgpvpn router association create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
[--project <project>]
[--project-domain <project-domain>]
<bgpvpn>
<router>
-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
--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.
bgpvpn
¶BGP VPN to apply the router association (name or ID)
router
¶Router to associate the BGP VPN (name or ID)
Delete a BGP VPN router association(s) for a given BGP VPN
openstack bgpvpn router association delete
<router
association
ID>
[<router association ID> ...]
<bgpvpn>
router
association ID
¶Router association ID(s) to remove
bgpvpn
¶BGP VPN the association belongs to (name or ID)
List BGP VPN router associations for a given BGP VPN
openstack bgpvpn router association list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
<bgpvpn>
-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
--long
¶List additional fields in output
bgpvpn
¶BGP VPN listed associations belong to (name or ID)
Show information of a given BGP VPN router association
openstack bgpvpn router association show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
<router
association
ID>
<bgpvpn>
-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
router
association ID
¶Router association ID to look up
bgpvpn
¶BGP VPN the association belongs to (name or ID)
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.