Chapter 13. bgpvpn

-h, --help

Show this help message and exit

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

--vni VNI

Vxlan network identifier to be used for this bgpvpn when a VXLAN encapsulation is used

--local-pref LOCAL_PREF

Default bgp local_pref to use in route advertisementstowards this BGPVPN.

--type {l2,l3}

Bgp vpn type selection between ip vpn (l3) and Ethernet VPN (l2) (default: l3)

-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

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

<bgpvpn>

Bgp vpn(s) to delete (name or id)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

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

-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

--quote {all,minimal,none,nonnumeric}

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.

<bgpvpn>

Bgp vpn to apply the network association (name or id)

<network>

Network to associate the bgp vpn (name or id)

-h, --help

Show this help message and exit

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

-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

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

<network association ID>

Network association id(s) to remove

<bgpvpn>

Bgp vpn the network association belongs to (name or ID)

-h, --help

Show this help message and exit

<bgpvpn>

Bgp vpn listed associations belong to (name or id)

-h, --help

Show this help message and exit

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

-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

--quote {all,minimal,none,nonnumeric}

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.

<network association ID>

Network association id to look up

<bgpvpn>

Bgp vpn the association belongs to (name or id)

-h, --help

Show this help message and exit

-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

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

<bgpvpn>

Bgp vpn to apply the port association (name or id)

<port>

Port to associate the bgp vpn (name or id)

-h, --help

Show this help message and exit

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

--advertise-fixed-ips

Fixed ips of the port will be advertised to the bgp VPN (default)

--no-advertise-fixed-ips

Fixed ips of the port will not be advertised to the BGP VPN

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Add prefix route in cidr notation. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple prefix routes)

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

Add bgp vpn route for route leaking. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple BGP VPN routes)

-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

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

<port association ID>

Port association id(s) to remove

<bgpvpn>

Bgp vpn the port association belongs to (name or id)

-h, --help

Show this help message and exit

<bgpvpn>

Bgp vpn listed associations belong to (name or id)

-h, --help

Show this help message and exit

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

-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

--quote {all,minimal,none,nonnumeric}

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.

<port association ID>

Port association id to update

<bgpvpn>

Bgp vpn the port association belongs to (name or id)

-h, --help

Show this help message and exit

--advertise-fixed-ips

Fixed ips of the port will be advertised to the bgp VPN

--no-advertise-fixed-ips

Fixed ips of the port will not be advertised to the BGP VPN

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Add prefix route in cidr notation. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple prefix routes)

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

Add bgp vpn route for route leaking. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple BGP VPN routes)

--no-prefix-route

Empty prefix route list

--no-bgpvpn-route

Empty bgp vpn route list

<port association ID>

Port association id to look up

<bgpvpn>

Bgp vpn the association belongs to (name or id)

-h, --help

Show this help message and exit

-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

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

<port association ID>

Port association id to update

<bgpvpn>

Bgp vpn the port association belongs to (name or id)

-h, --help

Show this help message and exit

--advertise-fixed-ips

Fixed ips of the port will not be advertised to the BGP VPN

--no-advertise-fixed-ips

Fixed ips of the port will be advertised to the bgp VPN

--prefix-route <cidr>

Remove prefix route in cidr notation (repeat option for multiple prefix routes)

--bgpvpn-route <BGP VPN ID or name>

Remove bgp vpn route (repeat option for multiple bgp VPN routes)

--all-prefix-routes

Empty prefix route list

--all-bgpvpn-routes

Empty bgp vpn route list

<bgpvpn>

Bgp vpn to apply the router association (name or id)

<router>

Router to associate the bgp vpn (name or id)

-h, --help

Show this help message and exit

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

--advertise_extra_routes

Routes will be advertised to the bgp vpn (default)

--no-advertise_extra_routes

Routes from the router will not be advertised to the BGP VPN

-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

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

<router association ID>

Router association id(s) to remove

<bgpvpn>

Bgp vpn the router association belongs to (name or id)

-h, --help

Show this help message and exit

<bgpvpn>

Bgp vpn listed associations belong to (name or id)

-h, --help

Show this help message and exit

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

-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

--quote {all,minimal,none,nonnumeric}

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.

<router association ID>

Router association id to update

<bgpvpn>

Bgp vpn the router association belongs to (name or id)

-h, --help

Show this help message and exit

--advertise_extra_routes

Routes will be advertised to the bgp vpn

--no-advertise_extra_routes

Routes from the router will not be advertised to the BGP VPN

<router association ID>

Router association id to look up

<bgpvpn>

Bgp vpn the association belongs to (name or id)

-h, --help

Show this help message and exit

-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

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

<router association ID>

Router association id to update

<bgpvpn>

Bgp vpn the router association belongs to (name or id)

-h, --help

Show this help message and exit

--advertise_extra_routes

Routes from the router will not be advertised to the BGP VPN

--no-advertise_extra_routes

Routes will be advertised to the bgp vpn

<bgpvpn>

Bgp vpn to update (name or id)

-h, --help

Show this help message and exit

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

--vni VNI

Vxlan network identifier to be used for this bgpvpn when a VXLAN encapsulation is used

--local-pref LOCAL_PREF

Default bgp local_pref to use in route advertisementstowards this BGPVPN.

<bgpvpn>

Bgp vpn to display (name or id)

-h, --help

Show this help message and exit

-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

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

<bgpvpn>

Bgp vpn to update (name or id)

-h, --help

Show this help message and exit

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

--vni VNI

Vxlan network identifier to be used for this bgpvpn when a VXLAN encapsulation is used

--local-pref LOCAL_PREF

Default bgp local_pref to use in route advertisementstowards this BGPVPN.