Share via

az network routeserver peering

Manage the route server peering.

Commands

Name Description Type Status
az network routeserver peering create

Create a route server peering.

 Core GA
az network routeserver peering delete

Delete a route server peering.

 Core GA
az network routeserver peering list

List all route server peerings under a resource group.

 Core GA
az network routeserver peering list-advertised-routes

List all routes the route server bgp connection is advertising to the specified peer.

 Core GA
az network routeserver peering list-learned-routes

List all routes the route server bgp connection has learned.

 Core GA
az network routeserver peering show

Show a route server peering.

 Core GA
az network routeserver peering update

Update a route server peering.

 Core GA
az network routeserver peering wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az network routeserver peering create

Edit

Create a route server peering.

az network routeserver peering create --name
                                      --resource-group
                                      --routeserver
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--peer-asn]
                                      [--peer-ip]

Examples

Create a route server peering.

az network routeserver peering create -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer --peer-asn 11000 --peer-ip 10.0.0.120

Required Parameters

--name -n

The name of the Route Server Peering.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--routeserver

The name of the Route Server.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--peer-asn

Peer ASN. Its range is from 1 to 4294967295.

--peer-ip

Peer IP address.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network routeserver peering delete

Edit

Delete a route server peering.

az network routeserver peering delete [--ids]
                                      [--name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--routeserver]
                                      [--subscription]
                                      [--yes]

Examples

Delete a route server peering.

az network routeserver peering delete -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer -y

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the Route Server Peering.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--routeserver

The name of the Route Server.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network routeserver peering list

Edit

List all route server peerings under a resource group.

az network routeserver peering list --resource-group
                                    --routeserver

Examples

List a route server peering.

az network routeserver peering list -g MyResourceGroup --routeserver MyRouteServer

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--routeserver

The name of the Route Server.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network routeserver peering list-advertised-routes

Edit

List all routes the route server bgp connection is advertising to the specified peer.

az network routeserver peering list-advertised-routes [--ids]
                                                      [--name]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--resource-group]
                                                      [--routeserver]
                                                      [--subscription]

Examples

List.

az network routeserver peering list-advertised-routes -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the Route Server Peering.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--routeserver

The name of the Route Server.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network routeserver peering list-learned-routes

Edit

List all routes the route server bgp connection has learned.

az network routeserver peering list-learned-routes [--ids]
                                                   [--name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--routeserver]
                                                   [--subscription]

Examples

List.

az network routeserver peering list-learned-routes -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the Route Server Peering.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--routeserver

The name of the Route Server.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network routeserver peering show

Edit

Show a route server peering.

az network routeserver peering show [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--routeserver]
                                    [--subscription]

Examples

Show a route server peering.

az network routeserver peering show -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the Route Server Peering.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--routeserver

The name of the Route Server.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network routeserver peering update

Edit

Update a route server peering.

az network routeserver peering update [--add]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--peer-asn]
                                      [--peer-ip]
                                      [--remove]
                                      [--resource-group]
                                      [--routeserver]
                                      [--set]
                                      [--subscription]

Examples

Update a route server peering.

az network routeserver peering update -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer --peer-ip 10.0.0.0

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the Route Server Peering.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--peer-asn

Peer ASN.

--peer-ip

Peer IP address.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--routeserver

The name of the Route Server.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network routeserver peering wait

Edit

Place the CLI in a waiting state until a condition is met.

az network routeserver peering wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--name]
                                    [--resource-group]
                                    [--routeserver]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30
--name -n

The name of the Route Server Peering.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--routeserver

The name of the Route Server.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.