Edit

Share via

New-AzNetworkCloudBgpAdvertisementObject

Module:
Az.NetworkCloud Module

Create an in-memory object for BgpAdvertisement.

Syntax

Default (Default) 

New-AzNetworkCloudBgpAdvertisementObject
    -IPAddressPool <String[]>
    [-AdvertiseToFabric <AdvertiseToFabric>]
    [-Community <String[]>]
    [-Peer <String[]>]
    [<CommonParameters>]

Description

Create an in-memory object for BgpAdvertisement.

Examples

Example 1: Create an in-memory object for BgpAdvertisement.

New-AzNetworkCloudBgpAdvertisementObject -IPAddressPool  @("pool1","pool2") -AdvertiseToFabric "True" -Community  @("communityString") -Peer @("peer1")

AdvertiseToFabric Community         IPAddressPool  Peer
----------------- ---------         -------------  ----
True              {communityString} {pool1, pool2} {peer1}

Create an in-memory object for BgpAdvertisement.

Parameters

-AdvertiseToFabric

The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False.

Parameter properties

Type:AdvertiseToFabric
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Community

The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPAddressPool

The names of the IP address pools associated with this announcement.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Peer

The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

BgpAdvertisement