PS_BgpRouter, ROOT\Microsoft\Windows\RemoteAccess

Class | Methods (4) | Properties | Qualifiers (5) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

BGP Router management class

PS_BgpRouter methods

PS_BgpRouter has 4 methods (4 Local)

NameOriginReturn
AddPS_BgpRouteruint32 {'out':True}
GetPS_BgpRouteruint32 {'out':True}
RemovePS_BgpRouteruint32 {'out':True}
SetPS_BgpRouteruint32 {'out':True}

Detailed description of PS_BgpRouter methods

Local methods (4) of PS_BgpRouter class

Add method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
BgpIdentifierstring0-{'Description':'Local BGP Router Identifier. The acceptable value for this parameter is an IPv4 address.','In':True}
LocalASNuint321-{'Description':'Local AS Number of the BGP Router instance.','In':True}
IPv6Routinguint322-{'Description':'Enum parameter for enabling or disabling IPv6 routing for this BGP Router.','In':True}
CompareMEDAcrossASNboolean3-{'Description':'Boolean parameter to enable comparison of MED values across different AS.','In':True}
DefaultGatewayRoutingboolean4-{'Description':'Boolean parameter to enable / disable routing of the unresolvable routes to the default (internet) gateway.','In':True}
PassThruboolean5-{'Description':'Indicates that cmdlet returns an output object.','In':True}
RoutingDomainstring6-{'Description':'User-defined unique alphanumeric ID for the Routing domain / Tenant.','In':True}
LocalIPv6Addressstring7-{'Description':'Local BGP Router?s global or site-local IPv6 Address, which is to be used as the NEXT-HOP value in the IPv6 route advertisments.','In':True}
cmdletOutputobject:BgpRouterConfig8-{'Description':'class BgpRouterConfig { string RoutingDomain Specifies the alphanumeric ID of the Routing Domain / Tenant. string BgpIdentifier Specifies the local BGP router's BGP Identifier int LocalASN Specifies the Local BGP router's AS Number ipaddress LocalIPv6Address Specifies the BGP router's global or site-local IP Address to be used as Next-Hop for IPv6 route advertisements boolean CompareMEDAcrossASN Specifies whether the MED value from two different ASNs are to be compared for BGP best path calculation boolean DefaultGatewayRouting Specifies whether the default gateway is to be used to route the unresolved traffic string IPv6Routing Specifies whether IPv6 routing is enabled or disabled string PeerName[] Specifies the list of peers that are configured for this BGP router string PolicyName[] Specifies the list of policies that are configured for this BGP router }','EmbeddedInstance':'BgpRouterConfig','Out':True}
Description'Add-BgpRouter cmdlet adds a new BGP router for the specified Tenant ID.'
implementedTrue
staticTrue
Add method is in 12 classes of ROOT\Microsoft\Windows\RemoteAccess and in 17 namespaces
Get method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RoutingDomainstring0-{'Description':'List of Tenant IDs for which the BGP router configuration is to be retrieved.','In':True}
cmdletOutputobject:BgpRouterConfig1-{'Description':'class BgpRouterConfig { string RoutingDomain Specifies the alphanumeric ID of the Routing Domain / Tenant. string BgpIdentifier Specifies the local BGP router's BGP Identifier int LocalASN Specifies the Local BGP router's AS Number ipaddress LocalIPv6Address Specifies the BGP router's global or site-local IP Address to be used as Next-Hop for IPv6 route advertisements boolean CompareMEDAcrossASN Specifies whether the MED value from two different ASNs are to be compared for BGP best path calculation boolean DefaultGatewayRouting Specifies whether the default gateway is to be used to route the unresolved traffic string IPv6Routing Specifies whether IPv6 routing is enabled or disabled string PeerName[] Specifies the list of peers that are configured for this BGP router string PolicyName[] Specifies the list of policies that are configured for this BGP router }','EmbeddedInstance':'BgpRouterConfig','Out':True}
Description'Get-BgpRouter cmdlet retrieves the BGP Router configuration information for one or more Tenant IDs.'
implementedTrue
staticTrue
Get method is in 28 classes of ROOT\Microsoft\Windows\RemoteAccess and in 19 namespaces
Remove method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RoutingDomainstring0-{'Description':'List of Routing Domains for which the BGP router is to be removed.','In':True}
Forceboolean1-{'Description':'Indicates no confirmation prompt before removing the BGP router for specified tenant.','In':True}
Description'Remove-BgpRouter cmdlet removes the BGP router for one or more Tenant IDs.'
implementedTrue
staticTrue
Remove method is in 13 classes of ROOT\Microsoft\Windows\RemoteAccess and in 18 namespaces
Set method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
BgpIdentifierstring0-{'Description':'Local BGP Router Identifier. The acceptable value for this parameter is an IPv4 address.','In':True}
LocalASNuint321-{'Description':'Local AS Number of the BGP Router instance.','In':True}
CompareMEDAcrossASNboolean2-{'Description':'Boolean parameter to enable comparison of MED values across different AS.','In':True}
DefaultGatewayRoutingboolean3-{'Description':'Boolean parameter to enable / disable routing of the unresolvable routes to the default (internet) gateway.','In':True}
IPv6Routinguint324-{'Description':'Enum parameter for enabling or disabling IPv6 routing for this BGP Router.','In':True}
RoutingDomainstring5-{'Description':'User-defined unique alphanumeric ID for the Routing domain / Tenant.','In':True}
PassThruboolean6-{'Description':'Indicates that cmdlet returns an output object.','In':True}
Forceboolean7-{'Description':'Indicates no confirmation prompt before modifying the configuration for router.','In':True}
LocalIPv6Addressstring8-{'Description':'Local BGP Router?s global or site-local IPv6 Address, which is to be used as the NEXT-HOP value in the IPv6 route advertisments.','In':True}
cmdletOutputobject:BgpRouterConfig9-{'Description':'class BgpRouterConfig { string RoutingDomain Specifies the alphanumeric ID of the Routing Domain / Tenant. string BgpIdentifier Specifies the local BGP router's BGP Identifier int LocalASN Specifies the Local BGP router's AS Number ipaddress LocalIPv6Address Specifies the BGP router's global or site-local IP Address to be used as Next-Hop for IPv6 route advertisements boolean CompareMEDAcrossASN Specifies whether the MED value from two different ASNs are to be compared for BGP best path calculation boolean DefaultGatewayRouting Specifies whether the default gateway is to be used to route the unresolved traffic string IPv6Routing Specifies whether IPv6 routing is enabled or disabled string PeerName[] Specifies the list of peers that are configured for this BGP router string PolicyName[] Specifies the list of policies that are configured for this BGP router }','EmbeddedInstance':'BgpRouterConfig','Out':True}
Description'Set-BgpRouter cmdlet modifies the configuration of the local BGP router for the specified Tenant ID.'
implementedTrue
staticTrue
Set method is in 18 classes of ROOT\Microsoft\Windows\RemoteAccess and in 20 namespaces

PS_BgpRouter Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
ClassVersion'1.0'
Description'BGP Router management class'
dynamicTrue
locale'MS_409'
provider'RAMgmtPSProvider'

PS_BgpRouter System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\Windows\RemoteAccess:PS_BgpRouter'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\Windows\RemoteAccess'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION[]___SYSTEM8
__PROPERTY_COUNT0___SYSTEM3
__RELPATH'PS_BgpRouter'___SYSTEM8
__DYNASTY'PS_BgpRouter'___SYSTEM8
__SUPERCLASSnull___SYSTEM8
__CLASS'PS_BgpRouter'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to PS_BgpRouter

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
BgpRouterConfig090----
WUtils.com
online utility - toplist