com.vmware package¶

Subpackages¶

com.vmware.nsx_vmc_app package

Submodules¶

com.vmware.nsx_vmc_app_client module¶

class com.vmware.nsx_vmc_app_client.Accounts(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get()¶

Retrieve the shadow account and linked VPC account information from VMC provider. This API is a live query to VMC provider.

Return type:	`com.vmware.nsx_vmc_app.model_client.VMCAccounts`
Returns:	com.vmware.nsx_vmc_app.model.VMCAccounts
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_client.LinkedVpcs(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get(linked_vpc_id)¶

Get linked VPC information.

Parameters:	linked_vpc_id (`str`) – (required)
Return type:	`com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo`
Returns:	com.vmware.nsx_vmc_app.model.LinkedVpcInfo
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()¶

List linked VPC information.

Return type:	`com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult`
Returns:	com.vmware.nsx_vmc_app.model.LinkedVpcsListResult
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_client.MgmtVms(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get(vm_id)¶

Get management VM access information.

Parameters:	vm_id (`str`) – (required)
Return type:	`com.vmware.nsx_vmc_app.model_client.MgmtVmInfo`
Returns:	com.vmware.nsx_vmc_app.model.MgmtVmInfo
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
Raise:	`com.vmware.vapi.std.errors_client.Error` Error description not available, Error description not available, Error description not available

list()¶

List Management VM information.

Return type:	`com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult`
Returns:	com.vmware.nsx_vmc_app.model.MgmtVmsListResult
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_client.PublicIps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(public_ip_id, force=None)¶

Delete a public IP. The IP will be released in VMC provider.

Parameters:	public_ip_id (`str`) – (required) force (`bool` or `None`) – Force delete the resource even if it is being used somewhere (optional, default to false)
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

get(public_ip_id)¶

Get the public IP information.

Parameters:	public_ip_id (`str`) – (required)
Return type:	`com.vmware.nsx_vmc_app.model_client.PublicIp`
Returns:	com.vmware.nsx_vmc_app.model.PublicIp
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()¶

List all public IPs obtained in the SDDC.

Return type:	`com.vmware.nsx_vmc_app.model_client.PublicIpsListResult`
Returns:	com.vmware.nsx_vmc_app.model.PublicIpsListResult
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(public_ip_id, public_ip)¶

This API is used to create or update a public IP. In creating, the API allocates a new public IP from VMC provider. In updating, only the display name can be modified, the IP is read-only.

Parameters:	public_ip_id (`str`) – (required) public_ip (`com.vmware.nsx_vmc_app.model_client.PublicIp`) – (required)
Return type:	`com.vmware.nsx_vmc_app.model_client.PublicIp`
Returns:	com.vmware.nsx_vmc_app.model.PublicIp
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_client.Routes(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get()¶

Retrieve BGP routes that are populated by Direct Connect from VMC provider. This API is a live query to VMC provider.

Return type:	`com.vmware.nsx_vmc_app.model_client.BGPRoutes`
Returns:	com.vmware.nsx_vmc_app.model.BGPRoutes
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_client.SddcUserConfig(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get()¶

Get the user-level SDDC configuration parameters

Return type:	`com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration`
Returns:	com.vmware.nsx_vmc_app.model.SddcUserConfiguration
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_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

class com.vmware.nsx_vmc_app_client.Vifs(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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