com.vmware.nsx.logical_routers.routing

Interface Bgp

All Superinterfaces:

BgpTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

BgpStub

public interface Bgp
extends com.vmware.vapi.bindings.Service, BgpTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
BgpConfig	get(java.lang.String logicalRouterId) Deprecated.
void	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback) Deprecated.
void	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
BgpConfig	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
BgpConfig	update(java.lang.String logicalRouterId, BgpConfig bgpConfig) Deprecated.
void	update(java.lang.String logicalRouterId, BgpConfig bgpConfig, com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback) Deprecated.
void	update(java.lang.String logicalRouterId, BgpConfig bgpConfig, com.vmware.vapi.bindings.client.AsyncCallback<BgpConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
BgpConfig	update(java.lang.String logicalRouterId, BgpConfig bgpConfig, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

get

@Deprecated
BgpConfig get(java.lang.String logicalRouterId)

Deprecated.

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.

Parameters:

logicalRouterId - (required)

Returns:

com.vmware.nsx.model.BgpConfig

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

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

Deprecated.

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.

Parameters:

logicalRouterId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BgpConfig

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

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

Deprecated.

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

Parameters:

logicalRouterId - (required)

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

get

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

Deprecated.

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

Parameters:

logicalRouterId - (required)

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

invocationConfig - Configuration for the method invocation.

update

@Deprecated
BgpConfig update(java.lang.String logicalRouterId,
                             BgpConfig bgpConfig)

Deprecated.

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.

Parameters:

logicalRouterId - (required)

bgpConfig - (required)

Returns:

com.vmware.nsx.model.BgpConfig

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

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

Deprecated.

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.

Parameters:

logicalRouterId - (required)

bgpConfig - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BgpConfig

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

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

Deprecated.

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

Parameters:

logicalRouterId - (required)

bgpConfig - (required)

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

update

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

Deprecated.

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

Parameters:

logicalRouterId - (required)

bgpConfig - (required)

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

invocationConfig - Configuration for the method invocation.