com.vmware.nsx_vmc_app package

Submodules

com.vmware.nsx_vmc_app.infra_client module

class com.vmware.nsx_vmc_app.infra_client.Accounts(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

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.infra_client.LinkedVpcs(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

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.infra_client.MgmtVms(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

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

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.infra_client.PublicIps(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

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
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.infra_client.SddcUserConfig(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

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.infra_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.model_client module

class com.vmware.nsx_vmc_app.model_client.AdvertisedRoute(advertisement_state=None, ipv4_cidr=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Advertised BGP route

Tip

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

Parameters
ADVERTISEMENT_STATE_FAILED = 'FAILED'
ADVERTISEMENT_STATE_SUCCESS = 'SUCCESS'
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.

Parameters

  • details (str or None) – Further details about the error

  • error_code (long or None) – A numeric error code format: int64

  • error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error

  • error_message (str or None) – A description of the error

  • module_name (str or None) – The module name where the error occurred

  • related_errors (list of RelatedApiError or None) – Other errors related to this error

class com.vmware.nsx_vmc_app.model_client.BGPAdvertisedRoutes(advertised_routes=None, failed_advertised_routes=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Advertised bgp routes

Tip

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

Parameters

  • advertised_routes (list of AdvertisedRoute or None) – Routes advertised to on-premise datacenter via Direct Connect

  • failed_advertised_routes (long or None) – Number of routes failed to advertise format: int32

class com.vmware.nsx_vmc_app.model_client.BGPLearnedRoutes(ipv4_cidr=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Learned bgp routes

Tip

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

Parameters

ipv4_cidr (list of str or None) – The route that is learned from BGP via Direct Connect format: ipv4-cidr-block

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • results (list of ConnectedServiceStatus) – Connected service status list

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.

Parameters

  • enabled (bool or None) – status of service This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • name (str or None) – service name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo(local_as_num=None, mtu=None, route_preference=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Direct Connect BGP related information

Tip

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

Parameters

  • local_as_num (str or None) – The ASN paired with the VGW attached to the VPC. AWS allowed private BGP ASN range - [64512, 65534] and [4200000000, 4294967294]. If omitted in the payload, BGP ASN will not be modified.

  • mtu (long or None) – Maximum transmission unit allowed by the VIF format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • route_preference (str or None) –

    Possible values are:

    Direct connect route preference over VPN routes. If omitted in the payload, route preference will not be modified.

ROUTE_PREFERENCE_DX_PREFERED_OVER_VPN = 'DX_PREFERED_OVER_VPN'
ROUTE_PREFERENCE_VPN_PREFERED_OVER_DX = 'VPN_PREFERED_OVER_DX'
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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • description (str or None) – Description of this resource

  • display_name (str or None) – Defaults to ID if not set

  • resource_type (str or None) – The type of this resource.

  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32

  • owner (OwnerResourceLink or None) – Owner of this resource

  • description (str or None) – Description of this resource

  • display_name (str or None) – Defaults to ID if not set

  • id (str or None) – Identifier of the resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • resource_type (str or None) – The type of this resource.

class com.vmware.nsx_vmc_app.model_client.HostEni(associated_public_ips=None, description=None, interface_id=None, interface_mac=None, primary_ip=None, subnet_id=None, vdr_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Host elastic network interface (ENI)

Tip

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

Parameters

  • associated_public_ips (list of str or None) – List of associated public IPs. format: ipv4

  • description (str or None) – Description

  • interface_id (str or None) – Interface id

  • interface_mac (str or None) – Interface mac

  • primary_ip (str or None) – Primary IP format: ipv4

  • subnet_id (str or None) – Subnet ID

  • vdr_type (str or None) – Virtual distributed router (VDR) type

class com.vmware.nsx_vmc_app.model_client.HostStatus(eni=None, host_id=None, host_ip=None, issues=None, vdr=None, vmcd_status=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Host status

Tip

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

Parameters
VMCD_STATUS_GREEN = 'GREEN'
VMCD_STATUS_RED = 'RED'
VMCD_STATUS_UNKNOWN = 'UNKNOWN'
class com.vmware.nsx_vmc_app.model_client.HostStatusListResult(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

Host status list result

Tip

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

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • results (list of HostStatus) – Connected service status list

class com.vmware.nsx_vmc_app.model_client.HostVdr(lifs=None, routes=None, type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Host virtual distributed router (VDR)

Tip

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

Parameters

  • lifs (list of VdrLif or None) – List of VDR lifs

  • routes (list of VdrRoute or None) – List of VDR routes

  • type (str or None) – VDR type

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • rx_bytes (long or None) – Count of bytes received on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • rx_errors (long or None) – Count of receive errors occurring on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • rx_packets (long or None) – Count of packets received on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • tx_bytes (long or None) – Count of bytes transmitted on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • tx_errors (long or None) – Count of transmit errors occurring on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • tx_packets (long or None) – Count of packets transmitted on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

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.

Parameters

  • attachment_id (str) – Attachment id which maps to management VM IP

  • ip (str) – Management VM IP Address format: ipv4

class com.vmware.nsx_vmc_app.model_client.LinkedSubnetInfo(availability_zone=None, cidr=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Infromation related to a subnet where linked ENIs were created.

Tip

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

Parameters

  • availability_zone (str) – Linked subnet availability zone

  • cidr (str) – Linked subnet CIDR format: ipv4-cidr-block

  • id (str) – Linked subnet identifier

class com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo(active_eni=None, arn_role=None, external_id=None, linked_account=None, linked_vpc_addresses=None, linked_vpc_id=None, linked_vpc_nat_ips=None, linked_vpc_subnets=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.

Parameters

  • active_eni (str or None) – Active network interface used for linked vpc traffic

  • arn_role (str) – ARN role for linked VPC operations

  • external_id (str) – External identifier for ARN role

  • linked_account (str) – Linked VPC account number

  • linked_vpc_addresses (list of str) – Linked VPC CIDRs format: ipv4-cidr-block

  • linked_vpc_id (str or None) – Linked VPC identifier

  • linked_vpc_nat_ips (list of str) – The IPs of linked VPC NAT rule for service access. format: ipv4

  • linked_vpc_subnets (list of LinkedSubnetInfo) – Infromation related to the subnets where linked ENIs were created.

  • route_table_ids (list of str) – The identifiers of route tables to be dynamically updated with SDDC networks

  • service_arn_role (str or None) – service ARN role

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • results (list of LinkedVpcInfo or None) – Linked VPCs list

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32

  • create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • description (str or None) – Description of this resource

  • display_name (str or None) – Defaults to ID if not set

  • id (str or None) – Unique identifier of this resource

  • resource_type (str or None) – The type of this resource.

  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user

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

Bases: vmware.vapi.bindings.struct.VapiStruct

A service entry describes the detail of a network service.

Tip

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

Parameters

  • display_name (str or None) – Display name for this service

  • path (str or None) – Service path should refer to a valid service in the system. Service can be system defined or user defined.

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.

Parameters

  • display_name (str or None) – Management VM name

  • group_path (str or None) – For each management VM, a dedicated policy group will be created. This property will reflect its group path. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • id (str or None) – Management VM identifier This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • ip_attachment_pairs (list of IpAttachmentPair or None) – IP address and attachment id pairs for tagging managment VM

  • ips (list of str or None) – Local IPs of a management VM format: address-or-block-or-range

  • services (list of MgmtServiceEntry or None) – Details services path and display name.

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • results (list of MgmtVmInfo or None) – Management VMs list

class com.vmware.nsx_vmc_app.model_client.NetworkStatusEntry(host_ips=None, ip_address=None, issues=None, issues_found=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Network status entry

Tip

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

Parameters

  • host_ips (list of str or None) – IPs of hosts that store this entry format: ipv4

  • ip_address (str or None) – IP address programmed with the entry format: ipv4

  • issues (list of str or None) – Known issues detected with the entry

  • issues_found (bool or None) – Indicate whether issues is a non-empty array

class com.vmware.nsx_vmc_app.model_client.NetworkStatusKey(context=None, network_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Key used to group network status inquiry results.

Tip

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

Parameters
CONTEXT_CONNECTED_VPC = 'CONNECTED_VPC'
CONTEXT_DIRECT_CONNECT = 'DIRECT_CONNECT'
CONTEXT_INVALID_NETWORK = 'INVALID_NETWORK'
CONTEXT_MANAGEMENT = 'MANAGEMENT'
CONTEXT_PUBLIC = 'PUBLIC'
NETWORK_TYPE_DNS = 'DNS'
NETWORK_TYPE_INFRA = 'INFRA'
NETWORK_TYPE_LOGICAL = 'LOGICAL'
NETWORK_TYPE_MANAGEMENT = 'MANAGEMENT'
NETWORK_TYPE_NAT = 'NAT'
NETWORK_TYPE_VPN = 'VPN'
class com.vmware.nsx_vmc_app.model_client.NetworkStatusKeyValuePair(key=None, values=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

List of network status

Tip

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

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

Bases: vmware.vapi.bindings.struct.VapiStruct

List of network status

Tip

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

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • issues (list of str or None) – List of overall issues encountered during the inquiry

  • results (list of NetworkStatusKeyValuePair) – List of network status key value pairs.

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.

Parameters

  • action (str or None) – Optional action This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • href (str or None) – Link to resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate definitions exist) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

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.

Parameters

  • display_name (str or None) – Display name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • prefixes (list of str) – Service IP prefixes format: ipv4-cidr-block

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • results (list of PrefixInfo or None) – Service Prefixes list

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.

Parameters

  • display_name (str or None) –

  • id (str or None) – Public IP identifier This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • ip (str or None) – IPv4 address format: ipv4 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • results (list of PublicIp or None) – Public IP list

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

Bases: vmware.vapi.bindings.struct.VapiStruct

Detailed information about a related API error

Tip

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

Parameters

  • details (str or None) – Further details about the error

  • error_code (long or None) – A numeric error code format: int64

  • error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error

  • error_message (str or None) – A description of the error

  • module_name (str or None) – The module name where the error occurred

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

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.

Parameters

  • action (str or None) – Optional action This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • href (str or None) – Link to resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate definitions exist) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32

class com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration(all_uplink_interface_label=None, all_vpn_interface_label=None, cgw_snat_ip=None, compute_gateway=None, dx_interface_label=None, linked_vpc_interface_label=None, management_gateway=None, management_gateway_label=None, mgmt_subnet=None, mgw_snat_ip=None, provider_name=None, public_interface_label=None, sddc_infra_subnet=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.

Parameters

  • all_uplink_interface_label (str) – All uplink interfaces label name

  • all_vpn_interface_label (str) – All VPN interfaces label name

  • cgw_snat_ip (str or None) – CGW SNAT ip address format: ipv4

  • compute_gateway (str) – Compute gateway name

  • dx_interface_label (str) – DirectConnect interface label name

  • linked_vpc_interface_label (str) – Linked VPC interface label name

  • management_gateway (str) – Management gateway name

  • management_gateway_label (str) – Management gateway label name

  • mgmt_subnet (list of str) – Management VMs CIDRs format: ipv4-cidr-block

  • mgw_snat_ip (str or None) – MGW SNAT ip address format: ipv4

  • provider_name (str) – Provider Name

  • public_interface_label (str) – Public interface label name

  • sddc_infra_subnet (list of str) – SDDC Infra CIDRs format: ipv4-cidr-block

  • vpn_dx_ips (list of str or None) – Local IPs for VPN tunnel over Direct Connect format: ipv4

  • vpn_internet_ips (list of str or None) – Public IPs for VPN tunnel over internet format: ipv4

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.

Parameters

  • action (str or None) – Optional action This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • href (str or None) – Link to resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate definitions exist) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_vmc_app.model_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.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.

Parameters

  • scope (str or None) – Tag searches may optionally be restricted by scope

  • tag (str or None) – Identifier meaningful to user

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • async_response_available (bool or None) – True if response for asynchronous request is available This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • cancelable (bool or None) – True if this task can be canceled This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • description (str or None) – Description of the task This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • end_time (long or None) – The end time of the task in epoch milliseconds format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • id (str or None) – Identifier for this task This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • message (str or None) – A message describing the disposition of the task This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • progress (long or None) – Task progress if known, from 0 to 100 format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • request_method (str or None) – HTTP request method This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • request_uri (str or None) – URI of the method invocation that spawned this task This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • start_time (long or None) – The start time of the task in epoch milliseconds format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • status (str or None) –

    Possible values are:

    Current status of the task

    This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • user (str or None) – Name of the user who created this task This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

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.TraceflowAction(component_name=None, component_sub_type=None, component_type=None, reason=None, resource_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

A component that processed the packet injected by traceflow

Tip

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

Parameters
COMPONENT_SUB_TYPE_AWS_GATEWAY = 'AWS_GATEWAY'
COMPONENT_SUB_TYPE_ENI = 'ENI'
COMPONENT_SUB_TYPE_VDR = 'VDR'
COMPONENT_TYPE_VMC = 'VMC'
class com.vmware.nsx_vmc_app.model_client.TraceflowActionListResults(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 containing all traceflow actions that have been taken to process the packet

Tip

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

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • results (list of TraceflowAction or None) – Result containing all traceflow actions that have processed the packet

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.

Parameters

  • linked_vpc_account (str or None) – linked VPC account number

  • shadow_account (str) – Shadow VPC account number

class com.vmware.nsx_vmc_app.model_client.VdrLif(id=None, ip=None, netmask=None, vlan_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Virtual distributed router (VDR) LIF

Tip

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

Parameters

  • id (str or None) – VDR LIF ID

  • ip (str or None) – VDR LIF IP format: ipv4

  • netmask (str or None) – VDR LIF subnet mask format: ipv4

  • vlan_id (long or None) – VDR LIF VLAN ID format: int64

class com.vmware.nsx_vmc_app.model_client.VdrRoute(destination=None, gateway=None, lif_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Virtual Distributed Router (VDR) route entry

Tip

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

Parameters

  • destination (str or None) – Destination IP CIDR Block format: ipv4-cidr-block

  • gateway (str or None) – Outgoing gateway

  • lif_id (str or None) – Outgoing Lif ID

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.

Parameters

  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • self (SelfResourceLink or None) – Link to this resource

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

  • results (list of VirtualInterface or None) – VIFs list

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

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
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'
class com.vmware.nsx_vmc_app.model_client.VmcConsolidatedRealizedStatus(consolidated_status=None, consolidated_status_per_object=None, intent_path=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents aggregated realized status for intent entity across associated realized entities.

Tip

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

Parameters

  • consolidated_status (VmcConsolidatedStatus or None) – Consolidated state of objects for a given intent entity.

  • consolidated_status_per_object (list of VmcConsolidatedStatusPerObject or None) – Aggregated consolidated status by enforcement point.

  • intent_path (str or None) – Intent path of the object representing this consolidated state.

class com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus(consolidated_status=None, status_message=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Consolidated status of an object.

Tip

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

Parameters
CONSOLIDATED_STATUS_ERROR = 'ERROR'
CONSOLIDATED_STATUS_IN_PROGRESS = 'IN_PROGRESS'
CONSOLIDATED_STATUS_SUCCESS = 'SUCCESS'
CONSOLIDATED_STATUS_UNAVAILABLE = 'UNAVAILABLE'
class com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatusPerObject(consolidated_status=None, object_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Realized status consolidated by individual objects.

Tip

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

Parameters

  • consolidated_status (VmcConsolidatedStatus or None) – Detailed consolidated realized status for an intent object.

  • object_id (str) – Object id used to consolidate state. This can be a particular backend task/job, etc.