com.vmware.nsx_vmc_app package

Subpackages

• com.vmware.nsx_vmc_app.infra package
  • Subpackages
    • com.vmware.nsx_vmc_app.infra.direct_connect package
      • Submodules
      • com.vmware.nsx_vmc_app.infra.direct_connect.routes_client module
    • com.vmware.nsx_vmc_app.infra.external package
      • Submodules
      • com.vmware.nsx_vmc_app.infra.external.routes_client module
  • Submodules
  • com.vmware.nsx_vmc_app.infra.direct_connect_client module
  • com.vmware.nsx_vmc_app.infra.external_client module
  • com.vmware.nsx_vmc_app.infra.linked_vpcs_client module
  • com.vmware.nsx_vmc_app.infra.realized_state_client module

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(sddc_group_id)

Delete the associated Group connection info for the local SDDC just before skynet service tries to remove the SDDC from the Group.

Parameters

sddc_group_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

get(sddc_group_id)

The API is used to get the associated Group connection info for the local SDDC. It returns the run time attachment state for the local SDDC, others infomations are from DB.

Parameters

sddc_group_id (str) – (required)

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx_vmc_app.model.AssociatedBaseGroupConnectionInfo The return value will contain all the attributes defined in com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.

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()

This API is used to list all associated Group connection infos for the local SDDC. It returns the run time attachment state for the local SDDC, others infomations are from DB.

Return type

com.vmware.nsx_vmc_app.model_client.AssociatedGroupConnectionInfosListResult

Returns

com.vmware.nsx_vmc_app.model.AssociatedGroupConnectionInfosListResult

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(sddc_group_id, associated_base_group_connection_info)

Create or update the associated Group connection info for the local SDDC just after skynet service adds the local SDDC to the Group and the attachment state is in available.

Parameters

• sddc_group_id (str) – (required)

• associated_base_group_connection_info (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx_vmc_app.model.AssociatedBaseGroupConnectionInfo The return value will contain all the attributes defined in com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(internal_name=None, name=None)

Get vmc environment feature flags

Parameters

• internal_name (str or None) – internal feature name (optional)

• name (str or None) – feature name (optional)

Return type

com.vmware.nsx_vmc_app.model_client.VmcFeatureFlags

Returns

com.vmware.nsx_vmc_app.model.VmcFeatureFlags

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(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

List all public IPs obtained in the SDDC.

Parameters

• cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

• included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

• page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

• sort_ascending (bool or None) – (optional)

• sort_by (str or None) – Field by which records are sorted (optional)

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.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 (str) –

  Possible values are:

  • AdvertisedRoute.ADVERTISEMENT_STATE_SUCCESS

  • AdvertisedRoute.ADVERTISEMENT_STATE_FAILED

  State of advertisement

• ipv4_cidr (str) – The route that is advertised to on-premise datacenter via Direct Connect format: ipv4-cidr-block

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.AssociatedBaseGroupConnectionInfo(description=None, id=None, name=None, resource_type='AssociatedBaseGroupConnectionInfo')

Bases: vmware.vapi.bindings.struct.VapiStruct

Base abstract associated Group connection infomation for the local SDDC.

Tip

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

Parameters

• description (str or None) – SDDC Group description

• id (str) – SDDC Group ID

• name (str or None) – SDDC Group name

• resource_type (str) –

  Possible values are:

  • AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO

    Group connection type

RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO = 'AssociatedTgwGroupConnectionInfo'

property resource_type

Return the discriminator value

class com.vmware.nsx_vmc_app.model_client.AssociatedGroupConnectionInfosListResult(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

Associated Group connection 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 vmware.vapi.struct.VapiStruct or None) – When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in AssociatedBaseGroupConnectionInfo. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in AssociatedBaseGroupConnectionInfo.

class com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo(external_route_table_id=None, sddcs_route_table_id=None, state=None, tgw_attachment_id=None, tgw_id=None, description=None, id=None, name=None, resource_type='AssociatedTgwGroupConnectionInfo')

Bases: vmware.vapi.bindings.struct.VapiStruct

Associated Group connection infomation for the local SDDC by using AWS TGW as a connector.

Tip

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

Parameters

• external_route_table_id (str) – TGW external route table ID used for external customers VPCs association

• sddcs_route_table_id (str) – TGW SDDCs route table ID used for SDDCs association

• state (str or None) –

  Possible values are:

  • AssociatedTgwGroupConnectionInfo.STATE_CONNECTED

  • AssociatedTgwGroupConnectionInfo.STATE_DISCONNECTED

  The TGW attachment state of the SDDC in the Group

• tgw_attachment_id (str) – TGW attachment ID for the local SDDC in the Group

• tgw_id (str) – TGW ID for the local SDDC in the Group

• description (str or None) – SDDC Group description

• id (str) – SDDC Group ID

• name (str or None) – SDDC Group name

• resource_type (str) –

  Possible values are:

  • AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO

    Group connection type

STATE_CONNECTED = 'CONNECTED'

STATE_DISCONNECTED = 'DISCONNECTED'

property resource_type

Return the discriminator value

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.CsvListResult(file_name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Base type for CSV result.

Tip

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

Parameters

file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.

class com.vmware.nsx_vmc_app.model_client.CsvRecord

Bases: vmware.vapi.bindings.struct.VapiStruct

Base type for CSV records.

Tip

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

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:

  • DirectConnectBgpInfo.ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN

  • DirectConnectBgpInfo.ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT

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

ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN = 'DIRECT_CONNECT_PREFERRED_OVER_VPN'

ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT = 'VPN_PREFERRED_OVER_DIRECT_CONNECT'

class com.vmware.nsx_vmc_app.model_client.DirectConnectConfig(connected_vpc_mtu=None, internet_mtu=None, intranet_mtu=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Direct Connect configuration

Tip

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

Parameters

• connected_vpc_mtu (long or None) – Uplink MTU of connected VPC traffic in edge tier-0 router port. 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.

• internet_mtu (long or None) – Uplink MTU of internet traffic in edge tier-0 router port. 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.

• intranet_mtu (long) – Uplink MTU of direct connect, sddc-grouping and outposts traffic in edge tier-0 router port. format: int32

class com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity(connectivity_type=None, error_message=None, source=None, status=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

External SDDC connectivity

Tip

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

Parameters

• connectivity_type (str) –

  Possible values are:

  • ExternalSddcConnectivity.CONNECTIVITY_TYPE_DIRECT_CONNECT

  • ExternalSddcConnectivity.CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP

  The external SDDC connectivity type is used by the SDDC for the L3 connectivity. DIRECT_CONNECT means that the external SDDC connectivity is through AWS Direct Connect. DEPLOYMENT_CONNECTIVITY_GROUP means that the external SDDC connectivity is through AWS TGW.

• error_message (str or None) – The error message if the status is FAILED

• source (str or None) – The source of the route for the connectivity

• status (str or None) –

  Possible values are:

  • ExternalSddcConnectivity.STATUS_SUCCEEDED

  • ExternalSddcConnectivity.STATUS_FAILED

  The status of the route for the connectivity

CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP = 'DEPLOYMENT_CONNECTIVITY_GROUP'

CONNECTIVITY_TYPE_DIRECT_CONNECT = 'DIRECT_CONNECT'

STATUS_FAILED = 'FAILED'

STATUS_SUCCEEDED = 'SUCCEEDED'

class com.vmware.nsx_vmc_app.model_client.ExternalSddcRoute(connectivities=None, destination=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

External SDDC route

Tip

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

Parameters

• connectivities (list of ExternalSddcConnectivity) – The route used for what kind of connectivities

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

class com.vmware.nsx_vmc_app.model_client.ExternalSddcRouteCsvRecord(connectivity_details=None, destination=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

CSV record for External SDDC route

Tip

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

Parameters

• connectivity_details (str) – The connectivity datails contains status of route, source of the route, connectivity type

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

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

Bases: vmware.vapi.bindings.struct.VapiStruct

External SDDC routes 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.

• routes (list of ExternalSddcRoute or None) –

class com.vmware.nsx_vmc_app.model_client.ExternalSddcRoutesListResultInCsvFormat(file_name=None, results=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

External SDDC routes list result in CSV format

Tip

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

Parameters

• file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.

• results (list of ExternalSddcRouteCsvRecord or None) –

class com.vmware.nsx_vmc_app.model_client.IncludedFieldsParameters(included_fields=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

A list of fields to include in query results

Tip

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

Parameters

included_fields (str or None) – Comma separated list of fields that should be included in query result

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.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.ModelInterface(id=None, name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Interface information (Label)

Tip

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

Parameters

• id (str) – Identifier of the Interface label

• name (str) – Name of the Interface label

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

class com.vmware.nsx_vmc_app.model_client.ResourceLink(action=None, href=None, rel=None)

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.SddcUserConfiguration(all_uplink_interface_label=None, all_vpn_interface_label=None, cgw_snat_ip=None, compute_domain=None, compute_gateway=None, dx_interface_label=None, interfaces=None, linked_vpc_interface_label=None, management_domain=None, management_gateway=None, management_gateway_label=None, mgmt_subnet=None, mgw_snat_ip=None, provider_gateways=None, provider_name=None, public_interface_label=None, sddc_infra_subnet=None, vpn_dx_ips=None, vpn_endpoints=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 or None) – All uplink interfaces label name. Deprecated, please use interfaces.

• all_vpn_interface_label (str or None) – All VPN interfaces label name. Deprecated, please use interfaces.

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

• compute_domain (str or None) – Compute domain id

• compute_gateway (str) – Compute gateway name

• dx_interface_label (str or None) – DirectConnect interface label name. Deprecated, please use interfaces.

• interfaces (list of ModelInterface or None) – Interfaces (labels) including public interface, direct connect interface, linked vpc interface, etc.

• linked_vpc_interface_label (str or None) – Linked VPC interface label name. Deprecated, please use interfaces.

• management_domain (str or None) – Management domain id

• management_gateway (str) – Management gateway name

• management_gateway_label (str) – Management gateway label name.

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

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

• provider_gateways (list of VmcKeyValueProviderGatewayListPair or None) – Provider gateway list. Including both tier-0 gateways and tier-1 gateways.

• provider_name (str) – Service provider Name

• public_interface_label (str or None) – Public interface label name. Deprecated, please use interfaces.

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

• vpn_dx_ips (list of str or None) – Local IPs for VPN tunnel over Direct Connect. Deprecated. Please use vpn_endpoints instead of vpn_dx_ips. format: ipv4

• vpn_endpoints (list of VpnEndpoint or None) – VPN tunnel endpoints. Currently containing public IPs for VPN over internet and local IPs for VPN over Direct Connect.

• vpn_internet_ips (list of str or None) – Public IPs for VPN tunnel over internet. Deprecated. Please use vpn_endpoints instead of vpn_internet_ips. format: ipv4

class com.vmware.nsx_vmc_app.model_client.SelfResourceLink(action=None, href=None, rel=None)

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.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.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 (str) –

  Possible values are:

  • VirtualInterface.BGP_STATUS_UP

  • VirtualInterface.BGP_STATUS_DOWN

  BGP status

• direct_connect_id (str) – Identifier for the Direct Connect

• id (str) – Identifier for the virtual interface

• local_ip (str or None) – amazon side 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.

• 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.

• name (str) – VIF name

• remote_asn (str or None) – Remote autonomous system number of vif This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

• remote_ip (str or None) – customer 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.

• state (str) –

  Possible values are:

  • VirtualInterface.STATE_CONFIRMING

  • VirtualInterface.STATE_VERIFYING

  • VirtualInterface.STATE_PENDING

  • VirtualInterface.STATE_AVAILABLE

  • VirtualInterface.STATE_DOWN

  • VirtualInterface.STATE_DELETING

  • VirtualInterface.STATE_DELETED

  • VirtualInterface.STATE_REJECTED

  • VirtualInterface.STATE_ATTACHED

  • VirtualInterface.STATE_ATTACHING

  • VirtualInterface.STATE_ERROR

  VIF State

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 (str or None) –

  Possible values are:

  • VmcConsolidatedStatus.CONSOLIDATED_STATUS_IN_PROGRESS

  • VmcConsolidatedStatus.CONSOLIDATED_STATUS_SUCCESS

  • VmcConsolidatedStatus.CONSOLIDATED_STATUS_ERROR

  • VmcConsolidatedStatus.CONSOLIDATED_STATUS_UNAVAILABLE

  Possible values could be IN_PROGRESS, SUCCESS, ERROR, UNAVAILABLE. IN_PROGRESS - The object realization is in progress. ERROR - The object realization fails or is caught in an error. SUCCESS - The realization succeeds. UNAVAILABLE - The object realization status is unavailable.

• status_message (str or None) – Help message for the current status regarding an object, providing information for each state.

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.

class com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo(internal_name=None, message=None, name=None, state=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

VMC Feature Flag

Tip

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

Parameters

• internal_name (str or None) – Internal 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.

• message (str or None) – Message

• name (str) – Feature Name

• state (str) –

  Possible values are:

  • VmcFeatureFlagInfo.STATE_ENABLED

  • VmcFeatureFlagInfo.STATE_DISABLED

  • VmcFeatureFlagInfo.STATE_INACTIVE

  state

STATE_DISABLED = 'disabled'

STATE_ENABLED = 'enabled'

STATE_INACTIVE = 'inactive'

class com.vmware.nsx_vmc_app.model_client.VmcFeatureFlags(features=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

VMC Feature flags

Tip

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

Parameters

features (list of VmcFeatureFlagInfo) –

class com.vmware.nsx_vmc_app.model_client.VmcKeyValueProviderGatewayListPair(key=None, value=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

A list for provider gateways

Tip

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

Parameters

• key (str) – Key

• value (list of VmcProviderGateway) – Value

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

Bases: vmware.vapi.bindings.struct.VapiStruct

Provider gateway, including tier-0s & tier-1s

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.

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

• path (str or None) – 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.

class com.vmware.nsx_vmc_app.model_client.VpnEndpoint(ip=None, name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

VPN endpoint information

Tip

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

Parameters

• ip (str) – IP address of VPN endpoint format: ipv4

• name (str) – Name of the VPN endpoint