com.vmware.nsx.logical_routers.routing

Class BgpStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.logical_routers.routing.BgpStub

All Implemented Interfaces:

Bgp, BgpTypes, com.vmware.vapi.bindings.Service

public class BgpStub
extends com.vmware.vapi.internal.bindings.Stub
implements Bgp

Remote stub implementation of the Bgp API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.logical_routers.routing.BgpTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
BgpStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
BgpStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
BgpConfig	get(java.lang.String logicalRouterId) Returns information about the BGP configuration on a specified logical router.
void	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback) Returns information about the BGP configuration on a specified logical router.
void	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the BGP configuration on a specified logical router.
BgpConfig	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the BGP configuration on a specified logical router.
BgpConfig	update(java.lang.String logicalRouterId, BgpConfig bgpConfig) Modifies the BGP configuration on a specified TIER0 logical router.
void	update(java.lang.String logicalRouterId, BgpConfig bgpConfig, com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback) Modifies the BGP configuration on a specified TIER0 logical router.
void	update(java.lang.String logicalRouterId, BgpConfig bgpConfig, com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies the BGP configuration on a specified TIER0 logical router.
BgpConfig	update(java.lang.String logicalRouterId, BgpConfig bgpConfig, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies the BGP configuration on a specified TIER0 logical router.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BgpStub

public BgpStub(com.vmware.vapi.core.ApiProvider apiProvider,
               com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
               com.vmware.vapi.bindings.StubConfigurationBase config)

BgpStub

public BgpStub(com.vmware.vapi.core.ApiProvider apiProvider,
               com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

get

public BgpConfig get(java.lang.String logicalRouterId)

Description copied from interface: Bgp

Returns information about the BGP configuration on a specified logical router. Information includes whether or not the BGP configuration is enabled, the AS number, and whether or not graceful restart is enabled.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//locale-services//bgp

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

get in interface Bgp

Parameters:

logicalRouterId - (required)

Returns:

com.vmware.nsx.model.BgpConfig

get

public BgpConfig get(java.lang.String logicalRouterId,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Bgp

Returns information about the BGP configuration on a specified logical router. Information includes whether or not the BGP configuration is enabled, the AS number, and whether or not graceful restart is enabled.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//locale-services//bgp

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Bgp

Parameters:

logicalRouterId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BgpConfig

get

public void get(java.lang.String logicalRouterId,
                com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback)

Description copied from interface: Bgp

Returns information about the BGP configuration on a specified logical router. Information includes whether or not the BGP configuration is enabled, the AS number, and whether or not graceful restart is enabled.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//locale-services//bgp

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.BgpConfig

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

get in interface Bgp

Parameters:

logicalRouterId - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

public void get(java.lang.String logicalRouterId,
                com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Bgp

Returns information about the BGP configuration on a specified logical router. Information includes whether or not the BGP configuration is enabled, the AS number, and whether or not graceful restart is enabled.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//locale-services//bgp

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.BgpConfig

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

get in interface Bgp

Parameters:

logicalRouterId - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

public BgpConfig update(java.lang.String logicalRouterId,
                        BgpConfig bgpConfig)

Description copied from interface: Bgp

Modifies the BGP configuration on a specified TIER0 logical router. Modifiable parameters include enabled, graceful_restart, as_number.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s//locale-services//bgp

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

update in interface Bgp

Parameters:

logicalRouterId - (required)

bgpConfig - (required)

Returns:

com.vmware.nsx.model.BgpConfig

update

public BgpConfig update(java.lang.String logicalRouterId,
                        BgpConfig bgpConfig,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Bgp

Modifies the BGP configuration on a specified TIER0 logical router. Modifiable parameters include enabled, graceful_restart, as_number.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s//locale-services//bgp

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

update in interface Bgp

Parameters:

logicalRouterId - (required)

bgpConfig - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BgpConfig

update

public void update(java.lang.String logicalRouterId,
                   BgpConfig bgpConfig,
                   com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback)

Description copied from interface: Bgp

Modifies the BGP configuration on a specified TIER0 logical router. Modifiable parameters include enabled, graceful_restart, as_number.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s//locale-services//bgp

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.BgpConfig

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

update in interface Bgp

Parameters:

logicalRouterId - (required)

bgpConfig - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

public void update(java.lang.String logicalRouterId,
                   BgpConfig bgpConfig,
                   com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Bgp

Modifies the BGP configuration on a specified TIER0 logical router. Modifiable parameters include enabled, graceful_restart, as_number.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s//locale-services//bgp

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.BgpConfig

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

update in interface Bgp

Parameters:

logicalRouterId - (required)

bgpConfig - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.