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

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get()

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

Return type

com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo

Returns

com.vmware.nsx_vmc_app.model.DirectConnectBgpInfo

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

patch(direct_connect_bgp_info)

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

Parameters

direct_connect_bgp_info (com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo) – (required)

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

update(direct_connect_bgp_info)

This API is used to create DX BGP related information.

Parameters

direct_connect_bgp_info (com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo) – (required)

Return type

com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo

Returns

com.vmware.nsx_vmc_app.model.DirectConnectBgpInfo

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_vmc_app.infra.direct_connect_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

CREATE_ACTION_ATTACH = 'ATTACH'

Possible value for action of method Vifs.create().

create(vif_id, action)

Attach the specified VIF (Virtual Interface) to the SDDC.

Parameters

• vif_id (str) – (required)

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

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

delete(vif_id)

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

Parameters

vif_id (str) – (required)

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

list()

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

Return type

com.vmware.nsx_vmc_app.model_client.VifsListResult

Returns

com.vmware.nsx_vmc_app.model.VifsListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

com.vmware.nsx_vmc_app.infra.external_client module

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get()

This API is used to get external configuration for north-south traffic. For eg., in AWS case, this would refer to Direct Connect config. For Dimension, this would refer to the config at Upstream Intranet interface to Tor.

Return type

com.vmware.nsx_vmc_app.model_client.ExternalConnectivityConfig

Returns

com.vmware.nsx_vmc_app.model.ExternalConnectivityConfig

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

This API is used to update intranet configuration for north-south traffic. For eg., in AWS case, this would refer to Direct Connect config. For Dimension, this would refer to the config at Upstream Intranet interface to Tor. Only the intranet MTU can be updated, internet mtu and connected VPC mtu are read-only.

Parameters

external_connectivity_config (com.vmware.nsx_vmc_app.model_client.ExternalConnectivityConfig) – (required)

Return type

com.vmware.nsx_vmc_app.model_client.ExternalConnectivityConfig

Returns

com.vmware.nsx_vmc_app.model.ExternalConnectivityConfig

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_vmc_app.infra.external_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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

com.vmware.nsx_vmc_app.infra.linked_vpcs_client module

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

list(linked_vpc_id)

List connected services to given linked vpc ID. The response consist of all available services along with their status.

Parameters

linked_vpc_id (str) – linked vpc id (required)

Return type

com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult

Returns

com.vmware.nsx_vmc_app.model.ConnectedServiceListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

update(linked_vpc_id, service_name, connected_service_status)

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

Parameters

• linked_vpc_id (str) – linked vpc id (required)

• service_name (str) – connected service name, e.g. s3 (required)

• connected_service_status (com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus) – (required)

Return type

com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus

Returns

com.vmware.nsx_vmc_app.model.ConnectedServiceStatus

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_vmc_app.infra.linked_vpcs_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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

com.vmware.nsx_vmc_app.infra.realized_state_client module

class com.vmware.nsx_vmc_app.infra.realized_state_client.RealizedEntities(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(intent_path, site_path=None)

Get the consolidated realized entities given an intent path, specified in the query parameter. The intent object under the intent path is indicated by a specific VMC-App API and can contain multiple objects.

Parameters

• intent_path (str) – String Path of the intent object (required)

• site_path (str or None) – String Path of the site (optional)

Return type

com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities

Returns

com.vmware.nsx_vmc_app.model.VmcRealizedEntities

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(intent_path, site_path=None)

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

Parameters

• intent_path (str) – String Path of the intent object (required)

• site_path (str or None) – String Path of the site (optional)

Return type

com.vmware.nsx_vmc_app.model_client.VmcConsolidatedRealizedStatus

Returns

com.vmware.nsx_vmc_app.model.VmcConsolidatedRealizedStatus

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_vmc_app.infra.realized_state_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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

com.vmware.nsx_vmc_app.infra.traffic_groups_client module

class com.vmware.nsx_vmc_app.infra.traffic_groups_client.AssociationMaps(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(traffic_group_id, map_id)

Delete the specified association map for a traffic group.

Parameters

• traffic_group_id (str) – Traffic group id (required)

• map_id (str) – Association map id (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(traffic_group_id, map_id)

Parameters

• traffic_group_id (str) – Traffic group id (required)

• map_id (str) – Association map id (required)

Return type

com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap

Returns

com.vmware.nsx_vmc_app.model.TrafficGroupAssociationMap

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

Retrieve association maps for a traffic group given its ID.

Parameters

traffic_group_id (str) – Traffic group id (required)

Return type

com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMapsListResult

Returns

com.vmware.nsx_vmc_app.model.TrafficGroupAssociationMapsListResult

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(traffic_group_id, map_id, traffic_group_association_map)

Parameters

• traffic_group_id (str) – Traffic group id (required)

• map_id (str) – Association map id (required)

• traffic_group_association_map (com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap) – (required)

Return type

com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap

Returns

com.vmware.nsx_vmc_app.model.TrafficGroupAssociationMap

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

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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