com.vmware.nsx_vmc_app.infra package¶

Subpackages¶

Submodules¶

com.vmware.nsx_vmc_app.infra.direct_connect_client module¶

class com.vmware.nsx_vmc_app.infra.direct_connect_client.Bgp(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters: config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get()¶

Get Direct Connect BGP related information, including current Autonomous System Number of the VGW attached to the VPC

Return type: com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo
Returns: com.vmware.nsx_vmc_app.model.DirectConnectBgpInfo
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

patch(direct_connect_bgp_info)¶

This API is used to update DX BGP related information. For ASN update, VIFs should be disconnected from the DX VGW before making this API call. The ASN update operation will be synchronous at this point. In the future the user should make use of the Get RealizationStatus call to check update status. While an ASN update call is in progress, any other DX BGP update request will be rejected.

Parameters: direct_connect_bgp_info (com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo) – (required)
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

update(direct_connect_bgp_info)¶

This API is used to create DX BGP related information.

Parameters: direct_connect_bgp_info (com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo) – (required)
Return type: com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo
Returns: com.vmware.nsx_vmc_app.model.DirectConnectBgpInfo
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.direct_connect_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters: config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

CREATE_ACTION_ATTACH = 'ATTACH'¶: Possible value for action of method Vifs.create().

create(vif_id, action)¶

Perform the attach operation in VMC provider to attach the specified VIF (Virtual Interface) to the SDDC.

Parameters

vif_id (str) – (required)
action (str) – Direct Connect VIF (Virtual Interface) action (required)

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

delete(vif_id)¶

Detach and delete a Direct Connect VIF (Virtual Interface) from the SDDC. Detach and delete are one operation in VMC provider, a Direct Connect VIF will be deleted after detached.

Parameters: vif_id (str) – (required)
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

list()¶

Return all non-connected VIFs (with states “avalible”, “down”, “pending” and “confirming”) and connected VIFs that are available to the SDDC.

Return type: com.vmware.nsx_vmc_app.model_client.VifsListResult
Returns: com.vmware.nsx_vmc_app.model.VifsListResult
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

com.vmware.nsx_vmc_app.infra.external_client module¶

class com.vmware.nsx_vmc_app.infra.external_client.Config(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters: config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get()¶

This API is used to get external configuration for direct connect, sddc-grouping, out-posts

Return type: com.vmware.nsx_vmc_app.model_client.DirectConnectConfig
Returns: com.vmware.nsx_vmc_app.model.DirectConnectConfig
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

update(direct_connect_config)¶

This API is used to create or update external configuration for direct connect, sddc-grouping, out-posts

Parameters: direct_connect_config (com.vmware.nsx_vmc_app.model_client.DirectConnectConfig) – (required)
Return type: com.vmware.nsx_vmc_app.model_client.DirectConnectConfig
Returns: com.vmware.nsx_vmc_app.model.DirectConnectConfig
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_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.nsx_vmc_app.infra.linked_vpcs_client module¶

class com.vmware.nsx_vmc_app.infra.linked_vpcs_client.ConnectedServices(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters: config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

list(linked_vpc_id)¶

List services connected to this linked vpc, for example, S3. The response consist of all available services along with their status.

Parameters: linked_vpc_id (str) – linked vpc id (required)
Return type: com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult
Returns: com.vmware.nsx_vmc_app.model.ConnectedServiceListResult
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

update(linked_vpc_id, service_name, connected_service_status)¶

Connect/Disconnect the service to the given linked vpc. For example, connect S3. The user will know what services are available through the GET call. If the user is trying to connect/disconnect an unknown service, the POST call will throw a 400 Bad Request error.

Parameters

linked_vpc_id (str) – linked vpc id (required)
service_name (str) – connected service name, e.g. s3 (required)
connected_service_status (com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus) – (required)

Return type

com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus

Returns

com.vmware.nsx_vmc_app.model.ConnectedServiceStatus

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.linked_vpcs_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.nsx_vmc_app.infra.realized_state_client module¶

class com.vmware.nsx_vmc_app.infra.realized_state_client.Status(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters: config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(intent_path)¶

Get the consolidated status of an intent object, specified by path in query parameter. The intent object is indicated by a specific VMC-App API and can contain multiple objects. For example, /infra/direct-connect/bgp can return the consolidated status of ASN update and route preference update.

Parameters: intent_path (str) – String Path of the intent object (required)
Return type: com.vmware.nsx_vmc_app.model_client.VmcConsolidatedRealizedStatus
Returns: com.vmware.nsx_vmc_app.model.VmcConsolidatedRealizedStatus
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.realized_state_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance