com.vmware.nsx_vmc_app package¶

Subpackages¶

com.vmware.nsx_vmc_app.infra 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.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 before removing 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 reflecting the SDDC’s association state with SDDC group.

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 associated with given ID.

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 all 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 public IP information associated with given ID.

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

class com.vmware.nsx_vmc_app.infra_client.TrafficGroups(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

CREATE_ACTION_END_RESTORE = 'END_RESTORE'¶: Possible value for action of method TrafficGroups.create().

CREATE_ACTION_SET_RESOURCE_STATUS_FAILURE = 'SET_RESOURCE_STATUS_FAILURE'¶: Possible value for action of method TrafficGroups.create().

CREATE_ACTION_SET_RESOURCE_STATUS_SUCCESS = 'SET_RESOURCE_STATUS_SUCCESS'¶: Possible value for action of method TrafficGroups.create().

CREATE_ACTION_START_RESTORE = 'START_RESTORE'¶: Possible value for action of method TrafficGroups.create().

create(traffic_group_id, action_message, action)¶

Perform an action on a Traffic Group

Parameters

traffic_group_id (str) – (required)
action_message (com.vmware.nsx_vmc_app.model_client.ActionMessage) – (required)
action (str) – Action performed on the Traffic Group (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(traffic_group_id)¶

Delete the Traffic Group, disassociate the prefix list with the traffic group.

Parameters: traffic_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(traffic_group_id)¶

Get the traffic group information by traffic group ID.

Parameters: traffic_group_id (str) – (required)
Return type: com.vmware.nsx_vmc_app.model_client.TrafficGroup
Returns: com.vmware.nsx_vmc_app.model.TrafficGroup
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(verbose=None)¶

A list of all traffic groups, which are associated with prefix lists.

Parameters: verbose (bool or None) – Verbose info requested (optional, default to false)
Return type: com.vmware.nsx_vmc_app.model_client.TrafficGroupsListResult
Returns: com.vmware.nsx_vmc_app.model.TrafficGroupsListResult
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, traffic_group)¶

This API is used to create or update a traffic group, a Prefix List is associated to the traffic group.

Parameters

traffic_group_id (str) – traffic group id (required)
traffic_group (com.vmware.nsx_vmc_app.model_client.TrafficGroup) – (required)

Return type

com.vmware.nsx_vmc_app.model_client.TrafficGroup

Returns

com.vmware.nsx_vmc_app.model.TrafficGroup

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

class com.vmware.nsx_vmc_app.model_client.ActionMessage(message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters: message (str or None) – Optional message for action

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 or None) –
Possible values are:
- AdvertisedRoute.ADVERTISEMENT_STATE_SUCCESS
- AdvertisedRoute.ADVERTISEMENT_STATE_FAILED
State of advertisement
ipv4_cidr (str or None) – 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(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='AssociatedBaseGroupConnectionInfo', tags=None, marked_for_delete=None, parent_path=None, path=None, relative_path=None, name=None)¶

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

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) – SDDC Group description
display_name (str or None) – Defaults to ID if not set
id (str or None) – SDDC Group ID
resource_type (str) –
Possible values are:
- AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO
  
  Group connection type
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent 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) – SDDC Group name

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, 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='AssociatedTgwGroupConnectionInfo', tags=None, marked_for_delete=None, parent_path=None, path=None, relative_path=None, name=None)¶

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 or None) – TGW external route table ID used for external customers VPCs association
sddcs_route_table_id (str or None) – 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 or None) – TGW attachment ID for the local SDDC in the Group
tgw_id (str or None) – TGW ID for the local SDDC in the Group
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) – SDDC Group description
display_name (str or None) – Defaults to ID if not set
id (str or None) – SDDC Group ID
resource_type (str) –
Possible values are:
- AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO
  
  Group connection type
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent 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) – SDDC Group name

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 or None) – Connected service status list

class com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None, 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

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
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
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(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None, 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

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
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
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.ExternalConnectivityConfig(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None, internet_mtu=None, intranet_mtu=None, services_mtu=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

External Connectivity 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.

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
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent 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 or None) – Uplink MTU of direct connect, sddc-grouping and outposts traffic in edge tier-0 router port. format: int32
services_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.

class com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity(connectivity_type=None, route_type=None, source=None, status=None, status_message=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 or None) –
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.
route_type (str or None) –
Possible values are:
- ExternalSddcConnectivity.ROUTE_TYPE_PROPAGATED
- ExternalSddcConnectivity.ROUTE_TYPE_STATIC
The type of the route for the connectivity
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
status_message (str or None) – The error message if the status is FAILED, the optional warning message if the status is SUCCEEDED.

CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP = 'DEPLOYMENT_CONNECTIVITY_GROUP'¶

CONNECTIVITY_TYPE_DIRECT_CONNECT = 'DIRECT_CONNECT'¶

ROUTE_TYPE_PROPAGATED = 'PROPAGATED'¶

ROUTE_TYPE_STATIC = 'STATIC'¶

STATUS_FAILED = 'FAILED'¶

STATUS_SUCCEEDED = 'SUCCEEDED'¶

class com.vmware.nsx_vmc_app.model_client.ExternalSddcRoute(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None, 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

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
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
connectivities (list of ExternalSddcConnectivity or None) – The route used for what kind of connectivities
destination (str or None) – 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 or None) – The connectivity datails contains status of route, source of the route, connectivity type
destination (str or None) – 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 or None) – Attachment id which maps to management VM IP
ip (str or None) – 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 or None) – Linked subnet availability zone
cidr (str or None) – Linked subnet CIDR format: ipv4-cidr-block
id (str or None) – Linked subnet identifier

class com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None, 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

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
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
active_eni (str or None) – Active network interface used for linked vpc traffic
arn_role (str or None) – ARN role for linked VPC operations
external_id (str or None) – External identifier for ARN role
linked_account (str or None) – Linked VPC account number
linked_vpc_addresses (list of str or None) – Linked VPC CIDRs format: ipv4-cidr-block
linked_vpc_id (str or None) – Linked VPC identifier
linked_vpc_nat_ips (list of str or None) – The IPs of linked VPC NAT rule for service access. format: ipv4
linked_vpc_subnets (list of LinkedSubnetInfo or None) – Infromation related to the subnets where linked ENIs were created.
route_table_ids (list of str or None) – 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(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None, group_path=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

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) – Management VM name
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.
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
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.
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 or None) – Identifier of the Interface label
name (str or None) – Name of the Interface label

class com.vmware.nsx_vmc_app.model_client.PrefixListInfo(name=None, path=None, url=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Prefix lists used by certain features, like Intranet NAT.

Tip

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

Parameters

name (str or None) – Prefix List name
path (str or None) – Relative Prefix List path
url (str or None) – Prefix List URL

class com.vmware.nsx_vmc_app.model_client.ProviderGatewayKeyValuePairs(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 or None) – Key
value (list of ProviderObject or None) – Value

class com.vmware.nsx_vmc_app.model_client.ProviderObject(display_name=None, id=None, path=None, type=None, url=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Basic properties of SDDC User Config.

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.
type (str or None) – Optional field, used to identify the object. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
url (str or None) – Should start with “/policy/api/v1/”. 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.PublicIp(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None, ip=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

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) –
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.
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent 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.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_domain=None, compute_gateway=None, domains=None, dx_interface_label=None, enforcement_points=None, gateways=None, infra_subnets=None, interfaces=None, labels=None, linked_vpc_interface_label=None, management_domain=None, management_gateway=None, management_gateway_default_dns_zone=None, management_gateway_label=None, mgmt_subnet=None, mgmt_subnets=None, mgw_snat_ip=None, provider_gateways=None, provider_name=None, provider_prefix_lists=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 labels.
all_vpn_interface_label (str or None) – All VPN interfaces label name. Deprecated, please use labels.
cgw_snat_ip (str or None) – Compute gateway SNAT IP address. format: ipv4
compute_domain (str or None) – Compute domain ID. Deprecated, please use domains.
compute_gateway (str or None) – Compute gateway name. Deprecated, please use gateways.
domains (list of ProviderObject or None) – Domain information for management gateway and compute gateway.
dx_interface_label (str or None) – DirectConnect interface label name. Deprecated, please use labels.
enforcement_points (list of ProviderObject or None) – Policy enforcement point object paths.
gateways (list of ProviderGatewayKeyValuePairs or None) – Provider gateway list. Including both tier-0 gateways and tier-1 gateways.
infra_subnets (list of str or None) – SDDC infra subnet CIDRs. format: ipv4-cidr-block
interfaces (list of ModelInterface or None) – Interfaces (labels) including public interface, direct connect interface, linked vpc interface, etc. Deprecated, please use labels.
labels (list of ProviderObject or None) – Interfaces (labels) including internet, intranet and services.
linked_vpc_interface_label (str or None) – Linked VPC interface label name. Deprecated, please use labels.
management_domain (str or None) – Management domain ID. Deprecated, please use domains.
management_gateway (str or None) – Management gateway name. Deprecated, please use gateways.
management_gateway_default_dns_zone (ProviderObject or None) – Management gateway default DNS zone
management_gateway_label (str or None) – Management gateway label name. Deprecated, please use labels.
mgmt_subnet (list of str or None) – Management subnet CIDRs. Deprecated, please use mgmt_subnets. format: ipv4-cidr-block
mgmt_subnets (list of str or None) – Management subnet CIDRs. format: ipv4-cidr-block
mgw_snat_ip (str or None) – Management gateway SNAT IP address. format: ipv4
provider_gateways (list of ProviderGatewayKeyValuePairs or None) – Provider gateway list. Including both tier-0 gateways and tier-1 gateways. Deprecated, please use gateways.
provider_name (str or None) – Service provider name. Deprecated, please use gateways.
provider_prefix_lists (list of PrefixListInfo or None) – Prefix lists used by certain features, like Intranet NAT.
public_interface_label (str or None) – Public interface label name. Deprecated, please use labels.
sddc_infra_subnet (list of str or None) – SDDC infra subnet CIDRs. Deprecated, please use infra_subnets. 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 intranet.
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.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 with maximum length of 256 characters

class com.vmware.nsx_vmc_app.model_client.TrafficGroup(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None, association_maps=None, resource_id=None, state=None, state_message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Traffic group configuration. A traffic group indicates dedicated bandwidth and computation for a given list of subnets. Creating a traffic group will reserve resources and associating it with desired prefix lists will use the resources for the traffic of the prefix lists. Besides traffic group ID and name, realized state and detailed association maps info of this traffic group are included if verbose info is requested.

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) – A description field for the traffic group.
id (str or None) – Unique identifier for a traffic group.
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
association_maps (list of TrafficGroupAssociationMap or None) – Association maps in the traffic group. 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_id (long or None) – Unique resource identifier for a traffic group. This identifier is used in the traffic group’s related resource allocation and naming. 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.
state (str or None) –
Possible values are:
- TrafficGroup.STATE_IN_PROGRESS
- TrafficGroup.STATE_SUCCESS
- TrafficGroup.STATE_FAILURE
- TrafficGroup.STATE_UNAVAILABLE
- TrafficGroup.STATE_PENDING
Realized state of the traffic group. This matches the realized state (VmcConsolidatedStatus) of the traffic group. 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_message (str or None) – Information on the current state. Mostly error messages on failure states. 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_FAILURE = 'FAILURE'¶

STATE_IN_PROGRESS = 'IN_PROGRESS'¶

STATE_PENDING = 'PENDING'¶

STATE_SUCCESS = 'SUCCESS'¶

STATE_UNAVAILABLE = 'UNAVAILABLE'¶

class com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None, prefix_lists=None, scope=None, state=None, state_message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

An association map of a traffic group. It describes the association of prefix lists and logical routers with the traffic group. To make use of dedicated traffic resources through traffic groups, prefix lists need to be linked to the desired traffic group and an association with the target logical router (scope) is required. The scope is for declaring which logical router the prefix lists are associated under a particular traffic group. The scope is not required input.

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) – A description field for Traffic group association map。
id (str or None) – The association map id.
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
prefix_lists (list of str or None) – The list of prefix lists to be associated.
scope (str or None) –
Possible values are:
- TrafficGroupAssociationMap.SCOPE__1S_CGW
- TrafficGroupAssociationMap.SCOPE__0S_VMC
The targeted logical router (scope) of prefix lists. Non admin users are not allowed to create, update, delete an association map with scope as /infra/tier-0s/vmc.
state (str or None) –
Possible values are:
- TrafficGroupAssociationMap.STATE_IN_PROGRESS
- TrafficGroupAssociationMap.STATE_SUCCESS
- TrafficGroupAssociationMap.STATE_FAILURE
- TrafficGroupAssociationMap.STATE_UNAVAILABLE
- TrafficGroupAssociationMap.STATE_PENDING
Realized state of the traffic group. This matches the realized state (VmcConsolidatedStatus) of the traffic group. 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_message (str or None) – Information on the current state. Mostly error messages on failure states. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

SCOPE_0S_VMC = '/infra/tier-0s/vmc'¶

SCOPE_1S_CGW = '/infra/tier-1s/cgw'¶

STATE_FAILURE = 'FAILURE'¶

STATE_IN_PROGRESS = 'IN_PROGRESS'¶

STATE_PENDING = 'PENDING'¶

STATE_SUCCESS = 'SUCCESS'¶

STATE_UNAVAILABLE = 'UNAVAILABLE'¶

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

List result for traffic group association maps.

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 TrafficGroupAssociationMap or None) – Traffic group association map list

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

List result for traffic groups.

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 TrafficGroup or None) – Traffic group list

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 or None) – 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 or None) –
Possible values are:
- VirtualInterface.BGP_STATUS_UP
- VirtualInterface.BGP_STATUS_DOWN
BGP status
direct_connect_id (str or None) – Identifier for the Direct Connect
id (str or None) – 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 or None) – 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 or None) –
Possible values are:
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.VmcAppBaseInfo(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Abstract base class for all the VmcApp objects.

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
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent 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.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:
Realized state of consolidation.
status_message (str or None) – Help message for the current status regarding an object, providing information for each state.

CONSOLIDATED_STATUS_FAILURE = 'FAILURE'¶

CONSOLIDATED_STATUS_IN_PROGRESS = 'IN_PROGRESS'¶

CONSOLIDATED_STATUS_PENDING = 'PENDING'¶

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 or None) – Object id used to consolidate state. This can be a particular backend task/job, etc.

class com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo(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, marked_for_delete=None, parent_path=None, path=None, relative_path=None, 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

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
marked_for_delete (bool or None) – marked for delete 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.
parent_path (str or None) – Path of its parent 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) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
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 or None) – Feature Name
state (str or None) –
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 or None) –

class com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities(intent_path=None, realized_entities=None, realized_entities_id=None, realized_state=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A consolidated object of realized entities given an intent path. This accounts for resources / entities which are realized under the intent path.

Tip

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

Parameters

intent_path (str or None) – Intent 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.
realized_entities (list of VmcRealizedEntity or None) – Detailed realized entities list. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
realized_entities_id (str or None) – Realized entities 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.
realized_state (str or None) –
Possible values are:
Realized state

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

REALIZED_STATE_FAILURE = 'FAILURE'¶

REALIZED_STATE_IN_PROGRESS = 'IN_PROGRESS'¶

REALIZED_STATE_PENDING = 'PENDING'¶

REALIZED_STATE_SUCCESS = 'SUCCESS'¶

REALIZED_STATE_UNAVAILABLE = 'UNAVAILABLE'¶

class com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity(realization_api=None, realization_id=None, realization_path=None, realized_entity_id=None, realized_entity_type=None, realized_state=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Realized entity object. This accounts for an resource / entity which is realized within cloud service.

Tip

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

Parameters

realization_api (str or None) – Resource realization API 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.
realization_id (str or None) – Resource realization id. This can differ from realized_entity_id as this can be an external 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.
realization_path (str or None) – The path for the realization of an entity. This can be an URI, etc. Some resources are identified by their paths. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
realized_entity_id (str or None) – Realized entity 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.
realized_entity_type (str or None) – Realized entity type This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
realized_state (str or None) –
Possible values are:
Realized state

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

REALIZED_STATE_FAILURE = 'FAILURE'¶

REALIZED_STATE_IN_PROGRESS = 'IN_PROGRESS'¶

REALIZED_STATE_PENDING = 'PENDING'¶

REALIZED_STATE_SUCCESS = 'SUCCESS'¶

REALIZED_STATE_UNAVAILABLE = 'UNAVAILABLE'¶

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

Bases: vmware.vapi.bindings.struct.VapiStruct

VPN endpoint information

Tip

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

Parameters

interface_label (str or None) – Interface label of the VPN endpoint
ip (str or None) – IP address of the VPN endpoint format: ipv4
name (str or None) – Name of the VPN endpoint
type (str or None) – Type of the VPN endpoint