com.vmware.nsx_vmc_app.infra.external package¶
Submodules¶
com.vmware.nsx_vmc_app.infra.external.routes_client module¶
-
class
com.vmware.nsx_vmc_app.infra.external.routes_client.
Advertised
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
LIST_CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP
= 'DEPLOYMENT_CONNECTIVITY_GROUP'¶ Possible value for
connectivityType
of methodAdvertised.list()
.
-
LIST_CONNECTIVITY_TYPE_DIRECT_CONNECT
= 'DIRECT_CONNECT'¶ Possible value for
connectivityType
of methodAdvertised.list()
.
-
list
(connectivity_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Retrieve routes that are advertised by the SDDC to the various connectivities. This API is a live query to VMC provider.
- Parameters
connectivity_type (
str
orNone
) – SDDC connectivity (optional)cursor (
str
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (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_vmc_app.model_client.ExternalSddcRoutesListResult
- Returns
com.vmware.nsx_vmc_app.model.ExternalSddcRoutesListResult
- Raise
com.vmware.vapi.std.errors_client.ServiceUnavailable
Service Unavailable- Raise
com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition Failed- Raise
com.vmware.vapi.std.errors_client.InternalServerError
Internal Server Error- Raise
com.vmware.vapi.std.errors_client.Unauthorized
Forbidden- Raise
com.vmware.vapi.std.errors_client.NotFound
Not Found
-
class
com.vmware.nsx_vmc_app.infra.external.routes_client.
Learned
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
LIST_CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP
= 'DEPLOYMENT_CONNECTIVITY_GROUP'¶ Possible value for
connectivityType
of methodLearned.list()
.
-
LIST_CONNECTIVITY_TYPE_DIRECT_CONNECT
= 'DIRECT_CONNECT'¶ Possible value for
connectivityType
of methodLearned.list()
.
-
list
(connectivity_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Retrieve routes that are learned for the SDDDC. This API is a db query.
- Parameters
connectivity_type (
str
orNone
) – SDDC connectivity (optional)cursor (
str
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (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_vmc_app.model_client.ExternalSddcRoutesListResult
- Returns
com.vmware.nsx_vmc_app.model.ExternalSddcRoutesListResult
- Raise
com.vmware.vapi.std.errors_client.ServiceUnavailable
Service Unavailable- Raise
com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition Failed- Raise
com.vmware.vapi.std.errors_client.InternalServerError
Internal Server Error- Raise
com.vmware.vapi.std.errors_client.Unauthorized
Forbidden- Raise
com.vmware.vapi.std.errors_client.NotFound
Not Found
-
class
com.vmware.nsx_vmc_app.infra.external.routes_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance