com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp package¶
Submodules¶
com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client module¶
-
class
com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client.
AdvertisedRoutes
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
Parameters: config ( vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.-
list
(tier0_id, locale_service_id, neighbor_id, count=None, cursor=None, enforcement_point_path=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Returns routes advertised by BGP neighbor from all edge transport nodes on which this neighbor is currently enabled. The query parameter “source=cached” is not supported.
Parameters: - tier0_id (
str
) – (required) - locale_service_id (
str
) – (required) - neighbor_id (
str
) – (required) - count (
long
orNone
) – Number of routes to retrieve (optional, default to 1000) - cursor (
str
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - enforcement_point_path (
str
orNone
) – Enforcement point path (optional) - included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional) - page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
bool
orNone
) – (optional) - sort_by (
str
orNone
) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.BgpNeighborRoutesListResult
Returns: com.vmware.nsx_policy.model.BgpNeighborRoutesListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable
Service UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- tier0_id (
-
-
class
com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client.
Routes
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
Parameters: config ( vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.-
list
(tier0_id, locale_service_id, neighbor_id, count=None, cursor=None, enforcement_point_path=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Returns routes learned by BGP neighbor from all edge nodes on which this neighbor is currently enabled.
Parameters: - tier0_id (
str
) – (required) - locale_service_id (
str
) – (required) - neighbor_id (
str
) – (required) - count (
long
orNone
) – Number of routes to retrieve (optional, default to 1000) - cursor (
str
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - enforcement_point_path (
str
orNone
) – Enforcement point path (optional) - included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional) - page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
bool
orNone
) – (optional) - sort_by (
str
orNone
) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.BgpNeighborRoutesListResult
Returns: com.vmware.nsx_policy.model.BgpNeighborRoutesListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable
Service UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- tier0_id (
-
-
class
com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client.
Status
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
Parameters: config ( vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.-
list
(tier0_id, locale_service_id, cursor=None, edge_path=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Parameters: - tier0_id (
str
) – (required) - locale_service_id (
str
) – (required) - cursor (
str
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - edge_path (
str
orNone
) – Policy path of edge node (optional) - enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional) - include_mark_for_delete_objects (
bool
orNone
) – Include objects that are marked for deletion in results (optional, default to false) - included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional) - page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
bool
orNone
) – (optional) - sort_by (
str
orNone
) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.PolicyBgpNeighborsStatusListResult
Returns: com.vmware.nsx_policy.model.PolicyBgpNeighborsStatusListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable
Service UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- tier0_id (
-
-
class
com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance