Set-BgpPeer

Set-BgpPeer

Updates the configuration of the specified BGP peer.

구문

Parameter Set: Set3
Set-BgpPeer [-Name] <String> [-CimSession <CimSession[]> ] [-ClearPrefixLimit] [-Force] [-HoldTimeSec <UInt16> ] [-IdleHoldTimeSec <UInt16> ] [-InformationAction <ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <String> ] [-LocalASN <UInt32> ] [-LocalIPAddress <IPAddress> ] [-MaxAllowedPrefix <UInt32> ] [-OperationMode <OperationMode> {Mixed | Server} ] [-PassThru] [-PeerASN <UInt32> ] [-PeeringMode <PeeringMode> {Automatic | Manual} ] [-PeerIPAddress <IPAddress> ] [-RouteReflectorClient <Boolean> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Weight <UInt16> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

자세한 설명

The Set-BgpPeer cmdlet updates the Border Gateway Protocol (BGP) peer configuration. This cmdlet returns error information if errors occur while modifying the BGP peer configuration.

매개 변수

-CimSession<CimSession[]>

원격 세션이나 원격 컴퓨터에서 cmdlet을 실행합니다. 컴퓨터 이름이나 New-CimSession 또는 Get-CimSession cmdlet의 출력과 같은 세션 개체를 입력하세요. 기본값은 로컬 컴퓨터 상의 현재 세션입니다.

별칭

Session

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

false

와일드카드 문자 허용 여부

false

-ClearPrefixLimit

Indicates that the cmdlet clears the maximum limit on prefixes learned from the peer. The cmdlet will reset the prefix learning to an unlimited number.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

false

와일드카드 문자 허용 여부

false

-Force

사용자에게 확인 메시지를 표시하지 않고 명령을 강제 실행합니다.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

false

와일드카드 문자 허용 여부

false

-HoldTimeSec<UInt16>

Specifies the configured value of the HoldTime parameter in seconds after which the BGP Session expires if no BGP message is received.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-IdleHoldTimeSec<UInt16>

Specifies the configured value of the IdleHoldTime in seconds after which the BGP Session expires if no BGP message is received.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-InformationAction<ActionPreference>

Specifies how this cmdlet responds to an information event. 이 매개 변수에 허용되는 값은 다음과 같습니다.

-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend

별칭

infa

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

false

와일드카드 문자 허용 여부

false

-InformationVariable<String>

Specifies a variable to store an information event message.

별칭

iv

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

false

와일드카드 문자 허용 여부

false

-LocalASN<UInt32>

Specifies the local autonomous systems (AS) number of the BGP Router instance for this peer.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-LocalIPAddress<IPAddress>

Specifies the local BGP router's peering IP address. It can be of IPv4 or IPv6 address type.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-MaxAllowedPrefix<UInt32>

Specifies the maximum number of allowed IPv4 or IPv6 network prefixes that can be learned from the given neighbor.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-Name<String>

Specifies the peer name for which the configuration is to be modified.

별칭

PeerId,PeerName

필수 여부

true

위치

2

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-OperationMode<OperationMode>

Specifies the BGP router's mode of operation. 이 매개 변수에 허용되는 값은 다음과 같습니다.
-- Peering Initiator as well as peering acceptor
-- Only acting as a passive peering request acceptor.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-PassThru

작업 중인 항목을 나타내는 개체를 반환합니다. 기본적으로 이 cmdlet은 출력을 생성하지 않습니다.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

false

와일드카드 문자 허용 여부

false

-PeerASN<UInt32>

Specifies the neighbor BGP router's AS number.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-PeeringMode<PeeringMode>

Specifies a value to configure peering mode for the given peer. 이 매개 변수에 허용되는 값은 다음과 같습니다.

-- Automatic
-- Manual

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-PeerIPAddress<IPAddress>

Specifies the neighbor BGP router's peering IP address. Acceptable values are an IPv4 or IPv6 address type.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-RouteReflectorClient<Boolean>

Specifies whether peer is a client peer or non-client peer.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-RoutingDomain<String>

Specifies the user-defined unique alphanumeric identifier for the routing domain.

별칭

RoutingDomainName

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of 0, the default value, 32, is used.

The throttle limit applies only to the current command, not to the session or to the computer.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

false

와일드카드 문자 허용 여부

false

-Weight<UInt16>

Specifies administrative preference assigned to the routes received from this peer.

별칭

none

필수 여부

false

위치

named

기본값

none

파이프라인 입력 허용 여부

true(ByPropertyName)

와일드카드 문자 허용 여부

false

-Confirm

cmdlet을 실행하기 전에 확인 메시지를 표시합니다.

필수 여부

false

위치

named

기본값

false

파이프라인 입력 허용 여부

false

와일드카드 문자 허용 여부

false

-WhatIf

cmdlet이 실행되는 경우 발생할 결과를 보여 줍니다. cmdlet은 실행되지 않습니다.

필수 여부

false

위치

named

기본값

false

파이프라인 입력 허용 여부

false

와일드카드 문자 허용 여부

false

<CommonParameters>

이 cmdlet은 -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable 등의 일반 매개 변수를 지원합니다. 자세한 내용은 TechNet의 about_CommonParameters(https://go.microsoft.com/fwlink/p/?LinkID=113216)

<WorkflowParameters>

입력

입력 형식은 cmdlet으로 파이프할 수 있는 개체의 형식입니다.

출력

출력 형식은 cmdlet 실행 시 출력되는 개체의 형식입니다.

  • Microsoft.Management.Infrastructure.CimInstance#BgpPeerConfig

Example 1: Update the BGP peer configuration for the specified neighbor

This command updates and modifies the BGP peer configuration for the specified neighbor.

PS C:\> Set-BgpPeer -Name "TenantSite1" -PeeringMode Automatic -PassThru

Example 2: Update and modify the BGP peer configuration and prompt the user for confirmation

This command prompts the user for confirmation and upon confirmation, updates and modifies the BGP peer configuration for the specified neighbor, which is active.

PS C:\> Set-BgpPeer -Name "TenantSite1" -OperationMode Mixed -PeeringMode Automatic -PassThru

Example 3: Update and modify the BGP peer configuration for the specified neighbor

This command prompts the user for confirmation and upon confirmation, updates and modifies the BGP peer configuration for the specified neighbor of a specified routing domain in multi-tenant environment.

PS C:\> Set-BgpPeer -RoutingDomain "Rd_002" -Name "Tenant1" -PeerASN 64515  -PassThru

관련 항목

Add-BgpPeer

Get-BgpPeer

Remove-BgpPeer

Set-BgpPeer

Start-BgpPeer

Stop-BgpPeer

Remote Access Cmdlets