com.vmware.nsx_global_policy.global_infra.tier_0s.locale_services.bgp.neighbors

Interface Status

All Superinterfaces:

com.vmware.vapi.bindings.Service, StatusTypes

All Known Implementing Classes:

StatusStub

public interface Status
extends com.vmware.vapi.bindings.Service, StatusTypes

Field Summary

Fields inherited from interface com.vmware.nsx_global_policy.global_infra.tier_0s.locale_services.bgp.neighbors.StatusTypes

_VAPI_SERVICE_ID, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME, LIST_STATS_TYPE_STATS

Method Summary

Modifier and Type	Method and Description
PolicyBgpNeighborsStatusListResult	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String statsType, java.lang.String transportNodeId) Returns the status of all the BGP neighbors for the given Tier0.
void	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String statsType, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyBgpNeighborsStatusListResult> asyncCallback) Returns the status of all the BGP neighbors for the given Tier0.
void	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String statsType, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyBgpNeighborsStatusListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the status of all the BGP neighbors for the given Tier0.
PolicyBgpNeighborsStatusListResult	list(java.lang.String tier0Id, java.lang.String localeServiceId, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String statsType, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the status of all the BGP neighbors for the given Tier0.

Method Detail

list

PolicyBgpNeighborsStatusListResult list(java.lang.String tier0Id,
                                        java.lang.String localeServiceId,
                                        java.lang.String cursor,
                                        java.lang.String edgePath,
                                        java.lang.String enforcementPointPath,
                                        java.lang.Boolean includeMarkForDeleteObjects,
                                        java.lang.String includedFields,
                                        java.lang.Long pageSize,
                                        java.lang.Boolean sortAscending,
                                        java.lang.String sortBy,
                                        java.lang.String source,
                                        java.lang.String statsType,
                                        java.lang.String transportNodeId)

Returns the status of all the BGP neighbors for the given Tier0. To get BGP neighbor status for a particular enforcement point, parameter \"enforcement_point_path=\" needs to be specified. If an enforcement_point is unspecified, then bgp neighbor status for all enforcement points is fetched. To get BGP neighbors status for the logical router from particular edge node, parameter \"edge_path=\" needs to be specified. If an edge_path is unspecified, then bgp neighbor status for all edges is fetched.

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

Parameters:

tier0Id - (required)

localeServiceId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

edgePath - Policy path of edge node (optional)

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

statsType - Segment statistics type (optional)

transportNodeId - Transport Node Id (optional)

Returns:

com.vmware.nsx_global_policy.model.PolicyBgpNeighborsStatusListResult

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

list

PolicyBgpNeighborsStatusListResult list(java.lang.String tier0Id,
                                        java.lang.String localeServiceId,
                                        java.lang.String cursor,
                                        java.lang.String edgePath,
                                        java.lang.String enforcementPointPath,
                                        java.lang.Boolean includeMarkForDeleteObjects,
                                        java.lang.String includedFields,
                                        java.lang.Long pageSize,
                                        java.lang.Boolean sortAscending,
                                        java.lang.String sortBy,
                                        java.lang.String source,
                                        java.lang.String statsType,
                                        java.lang.String transportNodeId,
                                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the status of all the BGP neighbors for the given Tier0. To get BGP neighbor status for a particular enforcement point, parameter \"enforcement_point_path=\" needs to be specified. If an enforcement_point is unspecified, then bgp neighbor status for all enforcement points is fetched. To get BGP neighbors status for the logical router from particular edge node, parameter \"edge_path=\" needs to be specified. If an edge_path is unspecified, then bgp neighbor status for all edges is fetched.

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:

tier0Id - (required)

localeServiceId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

edgePath - Policy path of edge node (optional)

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

statsType - Segment statistics type (optional)

transportNodeId - Transport Node Id (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_global_policy.model.PolicyBgpNeighborsStatusListResult

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

list

void list(java.lang.String tier0Id,
          java.lang.String localeServiceId,
          java.lang.String cursor,
          java.lang.String edgePath,
          java.lang.String enforcementPointPath,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String source,
          java.lang.String statsType,
          java.lang.String transportNodeId,
          com.vmware.vapi.bindings.client.AsyncCallback<PolicyBgpNeighborsStatusListResult> asyncCallback)

Returns the status of all the BGP neighbors for the given Tier0. To get BGP neighbor status for a particular enforcement point, parameter \"enforcement_point_path=\" needs to be specified. If an enforcement_point is unspecified, then bgp neighbor status for all enforcement points is fetched. To get BGP neighbors status for the logical router from particular edge node, parameter \"edge_path=\" needs to be specified. If an edge_path is unspecified, then bgp neighbor status for all edges is fetched.

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

Invocation Result:
com.vmware.nsx_global_policy.model.PolicyBgpNeighborsStatusListResult

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

Parameters:

tier0Id - (required)

localeServiceId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

edgePath - Policy path of edge node (optional)

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

statsType - Segment statistics type (optional)

transportNodeId - Transport Node Id (optional)

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

list

void list(java.lang.String tier0Id,
          java.lang.String localeServiceId,
          java.lang.String cursor,
          java.lang.String edgePath,
          java.lang.String enforcementPointPath,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String source,
          java.lang.String statsType,
          java.lang.String transportNodeId,
          com.vmware.vapi.bindings.client.AsyncCallback<PolicyBgpNeighborsStatusListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the status of all the BGP neighbors for the given Tier0. To get BGP neighbor status for a particular enforcement point, parameter \"enforcement_point_path=\" needs to be specified. If an enforcement_point is unspecified, then bgp neighbor status for all enforcement points is fetched. To get BGP neighbors status for the logical router from particular edge node, parameter \"edge_path=\" needs to be specified. If an edge_path is unspecified, then bgp neighbor status for all edges is fetched.

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_global_policy.model.PolicyBgpNeighborsStatusListResult

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

Parameters:

tier0Id - (required)

localeServiceId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

edgePath - Policy path of edge node (optional)

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

statsType - Segment statistics type (optional)

transportNodeId - Transport Node Id (optional)

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

invocationConfig - Configuration for the method invocation.