com.vmware.nsx_vmc_app package

Submodules

com.vmware.nsx_vmc_app.linked_vpcs_client module

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

Bases: vmware.vapi.bindings.stub.VapiInterface

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

Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.nsx_vmc_app.model_client module

class com.vmware.nsx_vmc_app.model_client.ApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Detailed information about an API error

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.BGPRoutes(bgp_routes=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

BGP routes

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

A list of status of ‘Enabled/Disabled’ for a service connected to a linked vpc

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus(enabled=None, name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Status of ‘Enabled/Disabled’ for a service connected to a linked vpc

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.DiscoveredResource(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Base class for resources that are discovered and automatically updated

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.EmbeddedResource(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Base class for resources that are embedded in other resources

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.InterfaceStatistics(links=None, schema=None, self_=None, rx_bytes=None, rx_errors=None, rx_packets=None, tx_bytes=None, tx_errors=None, tx_packets=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Statistics for a network interface

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.IpAttachmentPair(attachment_id=None, ip=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo(arn_role=None, external_id=None, linked_account=None, linked_vpc_addresses=None, linked_vpc_id=None, linked_vpc_nat_ips=None, linked_vpc_subnet_addresses=None, route_table_ids=None, service_arn_role=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Linked VPC info

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Linked VPC list query result

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.ListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Base class for list results from collections

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.ManagedResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Base type for resources that are managed by API clients

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry(display_name=None, name=None, path=None, ports=None, resource_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Service entry describes the detail of a network service. Either a existing service path or TCP/UDP/ICMP protocol/ports details could be specified.

Tip

The arguments are used to initialize data attributes with the same names.

RESOURCE_TYPE_ICMPENTRY = 'ICMPEntry'
RESOURCE_TYPE_TCPENTRY = 'TCPEntry'
RESOURCE_TYPE_UDPENTRY = 'UDPEntry'
class com.vmware.nsx_vmc_app.model_client.MgmtVmInfo(display_name=None, group_path=None, id=None, ip_attachment_pairs=None, ips=None, services=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Management VM access information

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Management VM list query result

Tip

The arguments are used to initialize data attributes with the same names.

Bases: vmware.vapi.bindings.struct.VapiStruct

The server will populate this field when returing the resource. Ignored on PUT and POST.

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.PrefixInfo(display_name=None, prefixes=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Service IP prefixes information

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.PrefixesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Service Prefix list query result

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.PublicIp(display_name=None, id=None, ip=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.PublicIpsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Public IP list

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.Resource(links=None, schema=None, self_=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Base class for resources

Tip

The arguments are used to initialize data attributes with the same names.

Bases: vmware.vapi.bindings.struct.VapiStruct

A link to a related resource

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.RevisionedResource(links=None, schema=None, self_=None, revision=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

A base class for types that track revisions

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration(compute_gateway=None, dx_interface_label=None, linked_vpc_interface_label=None, management_gateway=None, mgmt_addresses=None, provider_name=None, public_interface_label=None, sddc_infra_addresses=None, vpn_dx_ips=None, vpn_internet_ips=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

SDDC configuration parameters for users. User-level addresses/CIDRs are provided.

Tip

The arguments are used to initialize data attributes with the same names.

Bases: vmware.vapi.bindings.struct.VapiStruct

The server will populate this field when returing the resource. Ignored on PUT and POST.

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

class com.vmware.nsx_vmc_app.model_client.Tag(scope=None, tag=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Arbitrary key-value pairs that may be attached to an entity

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.TaskProperties(links=None, schema=None, self_=None, async_response_available=None, cancelable=None, description=None, end_time=None, id=None, message=None, progress=None, request_method=None, request_uri=None, start_time=None, status=None, user=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Task properties

Tip

The arguments are used to initialize data attributes with the same names.

STATUS_CANCELED = 'canceled'
STATUS_CANCELING = 'canceling'
STATUS_ERROR = 'error'
STATUS_KILLED = 'killed'
STATUS_RUNNING = 'running'
STATUS_SUCCESS = 'success'
class com.vmware.nsx_vmc_app.model_client.VMCAccounts(linked_vpc_account=None, shadow_account=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Shadow account and linked VPC account

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.VifsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Direct Connect VIFs (Virtual Interface) list query result

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_vmc_app.model_client.VirtualInterface(bgp_status=None, direct_connect_id=None, id=None, name=None, state=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

BGP_STATUS_DOWN = 'DOWN'
BGP_STATUS_UP = 'UP'
STATE_ATTACHED = 'ATTACHED'
STATE_ATTACHING = 'ATTACHING'
STATE_AVAILABLE = 'AVAILABLE'
STATE_CONFIRMING = 'CONFIRMING'
STATE_DELETED = 'DELETED'
STATE_DELETING = 'DELETING'
STATE_DOWN = 'DOWN'
STATE_ERROR = 'ERROR'
STATE_PENDING = 'PENDING'
STATE_REJECTED = 'REJECTED'
STATE_VERIFYING = 'VERIFYING'