com.vmware.vmc package

Subpackages

Submodules

com.vmware.vmc.customer_support_client module

class com.vmware.vmc.customer_support_client.Inputs(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(user_id, org_id)

Query list of sddc from org for a user

Parameters

  • user_id (str) – User ID requesting data (required)

  • org_id (str) – Org Id of user requesting data (required)

Return type

com.vmware.vmc.model_client.SddcInput

Returns

com.vmware.vmc.model.SddcInput

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request

Raise

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

class com.vmware.vmc.customer_support_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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

com.vmware.vmc.model_client module

class com.vmware.vmc.model_client.AbstractEntity(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • updated (datetime.datetime) –

  • user_id (str) – User id that last updated this record

  • updated_by_user_id (str) – User id that last updated this record

  • created (datetime.datetime) –

  • version (long) – Version of this entity format: int32

  • updated_by_user_name (str or None) – User name that last updated this record

  • user_name (str) – User name that last updated this record

  • id (str) – Unique ID for this entity

class com.vmware.vmc.model_client.AccountLinkConfig(delay_account_link=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

delay_account_link (bool or None) – Boolean flag identifying whether account linking should be delayed or not for the SDDC.

class com.vmware.vmc.model_client.AccountLinkSddcConfig(customer_subnet_ids=None, connected_account_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • customer_subnet_ids (list of str or None) –

  • connected_account_id (str or None) – The ID of the customer connected account to work with.

class com.vmware.vmc.model_client.Agent(sddc_csp_oauth_client=None, addresses=None, internal_ip=None, hostname_verifier_enabled=None, cert_enabled=None, network_cidr=None, id=None, tenant_service_info=None, tinyproxy_whitelist=None, healthy=None, custom_properties=None, management_ip=None, master=None, network_netmask=None, network_gateway=None, provider='Agent', agent_url=None, agent_state=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • sddc_csp_oauth_client (AgentCspOauthClient or None) – CSP Oauth client credentials to access information from POP.

  • addresses (list of str or None) – The addresses of the agent including its public IP and DNS names.

  • internal_ip (str or None) – The internal IP address of the agent which is provided by the underlying cloud provider

  • hostname_verifier_enabled (bool or None) – Boolean flag to indicate if the agent is using FQDN in the certificate

  • cert_enabled (bool or None) – Boolean flag to indicate if the agent is using CA signed certificate

  • network_cidr (str or None) – Network CIDR of the agent

  • id (str or None) – The agent id

  • tenant_service_info (TenantServiceInfo or None) – Tenant service information that we will save as a part of agent data.

  • tinyproxy_whitelist (list of str or None) – The list of white listed domains of the HTTP proxy.

  • healthy (bool or None) – Boolean flag to indicate if the agent is healthy.

  • custom_properties ((dict of str and str) or None) –

  • management_ip (str or None) – The internal management IP address of the agent exposed to the SDDC, which might be different from the internal IP

  • master (bool or None) – Boolean flag to indicate if the agent is the master, only the master Agent is accessible

  • network_netmask (str or None) – Network netmask of the agent

  • network_gateway (str or None) – Network gateway of the agent

  • provider (str) – The cloud provider

  • agent_url (str or None) – The accessible URL of the agent service, it is resolved to public IP address from the Internet and private IP address within SDDC

  • agent_state (str or None) –

    Possible values are:

    Agent state

AGENT_STATE_CUSTOMIZING = 'CUSTOMIZING'
AGENT_STATE_DELETED = 'DELETED'
AGENT_STATE_DELETING = 'DELETING'
AGENT_STATE_DEPLOYING = 'DEPLOYING'
AGENT_STATE_FAILED = 'FAILED'
AGENT_STATE_NOT_READY = 'NOT_READY'
AGENT_STATE_READY = 'READY'
property provider

Return the discriminator value

class com.vmware.vmc.model_client.AgentCspOauthClient(csp_oauth_client=None, create_at=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • csp_oauth_client (AgentOauthClient) – Agent CSP Oauth client credentials.

  • create_at (datetime.datetime) – The Oauth client creation time. format: date-time

class com.vmware.vmc.model_client.AgentOauthClient(client_secret=None, client_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • client_secret (str) – The Oauth client secret.

  • client_id (str) – The Oauth client ID.

class com.vmware.vmc.model_client.AmiInfo(instance_type=None, region=None, id=None, name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

the AmiInfo used for deploying esx of the sddc

Tip

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

Parameters

  • instance_type (str or None) – instance type of the esx ami

  • region (str or None) – the region of the esx ami

  • id (str or None) – the ami id for the esx

  • name (str or None) – the name of the esx ami

class com.vmware.vmc.model_client.AvailableZoneInfo(subnets=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • subnets (list of Subnet or None) –

  • id (str or None) – available zone id

class com.vmware.vmc.model_client.AwsAgent(instance_id=None, availability_zone_info_id=None, instance_profile_info=None, key_pair=None, default_eni_id=None, sddc_csp_oauth_client=None, addresses=None, internal_ip=None, hostname_verifier_enabled=None, cert_enabled=None, network_cidr=None, id=None, tenant_service_info=None, tinyproxy_whitelist=None, healthy=None, custom_properties=None, management_ip=None, master=None, network_netmask=None, network_gateway=None, provider='AWS', agent_url=None, agent_state=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • instance_id (str or None) –

  • availability_zone_info_id (str or None) –

  • instance_profile_info (InstanceProfileInfo or None) –

  • key_pair (AwsKeyPair or None) –

  • default_eni_id (str or None) –

  • sddc_csp_oauth_client (AgentCspOauthClient or None) – CSP Oauth client credentials to access information from POP.

  • addresses (list of str or None) – The addresses of the agent including its public IP and DNS names.

  • internal_ip (str or None) – The internal IP address of the agent which is provided by the underlying cloud provider

  • hostname_verifier_enabled (bool or None) – Boolean flag to indicate if the agent is using FQDN in the certificate

  • cert_enabled (bool or None) – Boolean flag to indicate if the agent is using CA signed certificate

  • network_cidr (str or None) – Network CIDR of the agent

  • id (str or None) – The agent id

  • tenant_service_info (TenantServiceInfo or None) – Tenant service information that we will save as a part of agent data.

  • tinyproxy_whitelist (list of str or None) – The list of white listed domains of the HTTP proxy.

  • healthy (bool or None) – Boolean flag to indicate if the agent is healthy.

  • custom_properties ((dict of str and str) or None) –

  • management_ip (str or None) – The internal management IP address of the agent exposed to the SDDC, which might be different from the internal IP

  • master (bool or None) – Boolean flag to indicate if the agent is the master, only the master Agent is accessible

  • network_netmask (str or None) – Network netmask of the agent

  • network_gateway (str or None) – Network gateway of the agent

  • provider (str) – The cloud provider

  • agent_url (str or None) – The accessible URL of the agent service, it is resolved to public IP address from the Internet and private IP address within SDDC

  • agent_state (str or None) –

    Possible values are:

    Agent state

property provider

Return the discriminator value

class com.vmware.vmc.model_client.AwsCloudProvider(regions=None, provider='AWS')

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • regions (list of str or None) –

  • provider (str) – Name of the Cloud Provider

property provider

Return the discriminator value

class com.vmware.vmc.model_client.AwsCompatibleSubnets(customer_available_zones=None, vpc_map=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • customer_available_zones (list of str or None) –

  • vpc_map ((dict of str and VpcInfoSubnets) or None) –

class com.vmware.vmc.model_client.AwsCustomerConnectedAccount(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, policy_payer_arn=None, region_to_az_to_shadow_mapping=None, org_id=None, cf_stack_name=None, state=None, account_number=None, policy_service_arn=None, policy_external_id=None, policy_payer_linked_arn=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • updated (datetime.datetime) –

  • user_id (str) – User id that last updated this record

  • updated_by_user_id (str) – User id that last updated this record

  • created (datetime.datetime) –

  • version (long) – Version of this entity format: int32

  • updated_by_user_name (str or None) – User name that last updated this record

  • user_name (str) – User name that last updated this record

  • id (str) – Unique ID for this entity

  • policy_payer_arn (str or None) –

  • region_to_az_to_shadow_mapping ((dict of str and (dict of str and str)) or None) – Provides a map of regions to availability zones from the shadow account’s perspective

  • org_id (str or None) –

  • cf_stack_name (str or None) –

  • state (str or None) –

    Possible values are:

  • account_number (str or None) –

  • policy_service_arn (str or None) –

  • policy_external_id (str or None) –

  • policy_payer_linked_arn (str or None) –

STATE_ACTIVE = 'ACTIVE'
STATE_BROKEN = 'BROKEN'
STATE_DELETED = 'DELETED'
class com.vmware.vmc.model_client.AwsEsxHost(capacity_pool=None, eni_list=None, xeni_info=None, partition_number=None, ec2_instance_running_status_count=None, esx_nic_info=None, internal_public_ip_pool=None, availability_zone=None, esx_id=None, durable_host_name=None, state_last_updated=None, name=None, custom_properties=None, hostname=None, provider='AWS', instance_type=None, mac_address=None, esx_state=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
property provider

Return the discriminator value

class com.vmware.vmc.model_client.AwsKeyPair(key_name=None, key_fingerprint=None, key_material=None, tags=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • key_name (str or None) –

  • key_fingerprint (str or None) –

  • key_material (str or None) –

  • tags (list of Tag or None) –

class com.vmware.vmc.model_client.AwsKmsInfo(amazon_resource_name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

amazon_resource_name (str) – The ARN associated with the customer master key for this cluster.

class com.vmware.vmc.model_client.AwsSddcConfig(existing_vpc_id=None, msft_license_config=None, account_link_config=None, vpc_cidr=None, skip_creating_vxlan=None, vxlan_subnet=None, size=None, outpost_id=None, storage_capacity=None, name=None, account_link_sddc_config=None, host_instance_type=None, region=None, sddc_id=None, sddc_template_id=None, sddc_type=None, vsan_version=None, provider='AWS', sso_domain=None, num_hosts=None, deployment_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • existing_vpc_id (str or None) –

  • msft_license_config (MsftLicensingConfig or None) – Indicates the desired licensing support, if any, of Microsoft software.

  • account_link_config (AccountLinkConfig or None) – The account linking configuration, we will keep this one and remove accountLinkSddcConfig finally.

  • vpc_cidr (str or None) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.

  • skip_creating_vxlan (bool or None) – skip creating vxlan for compute gateway for SDDC provisioning

  • vxlan_subnet (str or None) – VXLAN IP subnet in CIDR for compute gateway

  • size (str or None) –

    Possible values are:

    The size of the vCenter and NSX appliances. “large” sddcSize corresponds to a ‘large’ vCenter appliance and ‘large’ NSX appliance. ‘medium’ sddcSize corresponds to ‘medium’ vCenter appliance and ‘medium’ NSX appliance. Value defaults to ‘medium’.

  • outpost_id (str or None) – Outpost ID of the SDDC. Used only for outpost deployments.

  • storage_capacity (long or None) – The storage capacity value to be requested for the sddc primary cluster, in GiBs. If provided, instead of using the direct-attached storage, a capacity value amount of seperable storage will be used. format: int64

  • name (str) –

  • account_link_sddc_config (list of AccountLinkSddcConfig or None) – A list of the SDDC linking configurations to use.

  • host_instance_type (str or None) –

    Possible values are:

    The instance type for the esx hosts in the primary cluster of the SDDC.

  • region (str or None) –

  • sddc_id (str or None) – If provided, will be assigned as SDDC id of the provisioned SDDC. format: UUID

  • sddc_template_id (str or None) – If provided, configuration from the template will applied to the provisioned SDDC. format: UUID

  • sddc_type (str or None) – Denotes the sddc type , if the value is null or empty, the type is considered as default.

  • vsan_version (str or None) –

    Possible values are:

    The vSAN version to be used in the SDDC’s primary cluster.

  • provider (str) –

    Possible values are:

    Determines what additional properties are available based on cloud provider.

  • sso_domain (str or None) – The SSO domain name to use for vSphere users. If not specified, vmc.local will be used.

  • num_hosts (long) –

  • deployment_type (str or None) –

    Possible values are:

    Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is SingleAZ.

property provider

Return the discriminator value

class com.vmware.vmc.model_client.AwsSddcConnection(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, cidr_block_subnet=None, connected_account_id=None, eni_group=None, subnet_id=None, cgw_present=None, org_id=None, sddc_id=None, cidr_block_vpc=None, connection_order=None, state=None, subnet_availability_zone=None, vpc_id=None, customer_eni_infos=None, default_route_table=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • updated (datetime.datetime) –

  • user_id (str) – User id that last updated this record

  • updated_by_user_id (str) – User id that last updated this record

  • created (datetime.datetime) –

  • version (long) – Version of this entity format: int32

  • updated_by_user_name (str or None) – User name that last updated this record

  • user_name (str) – User name that last updated this record

  • id (str) – Unique ID for this entity

  • cidr_block_subnet (str or None) – The CIDR block of the customer’s subnet this link is in.

  • connected_account_id (str or None) – The corresponding connected (customer) account UUID this connection is attached to.

  • eni_group (str or None) – Which group the ENIs belongs to. (deprecated)

  • subnet_id (str or None) – The ID of the subnet this link is to.

  • cgw_present (bool or None) – Determines whether the CGW is present in this connection set or not. Used for multi-az deployments.

  • org_id (str or None) – The org this link belongs to.

  • sddc_id (str or None) – The SDDC this link is used for.

  • cidr_block_vpc (str or None) – The CIDR block of the customer’s VPC.

  • connection_order (long or None) – The order of the connection

  • state (str or None) –

    Possible values are:

    The state of the connection.

  • subnet_availability_zone (str or None) – Which availability zone is this connection in?

  • vpc_id (str or None) – The VPC ID of the subnet this link is to.

  • customer_eni_infos (list of CustomerEniInfo or None) – A list of all ENIs used for this connection.

  • default_route_table (str or None) – The default routing table in the customer’s VPC.

STATE_ACTIVE = 'ACTIVE'
STATE_BROKEN = 'BROKEN'
STATE_DELETED = 'DELETED'
class com.vmware.vmc.model_client.AwsSddcResourceConfig(backup_restore_bucket=None, public_ip_pool=None, vpc_info=None, mgw_public_ip_pool=None, kms_vpc_endpoint=None, max_num_public_ip=None, esx_instance_profile=None, account_link_sddc_config=None, vsan_encryption_config=None, nsx_user_client=None, vpc_info_peered_agent=None, nsx_service_client=None, vc_ip=None, mgmt_appliance_network_name=None, nsx_mgr_url=None, vlcm_enabled=None, nsx_cloud_audit_password=None, vc_csp_login_status=None, nsx_cloud_admin_password=None, management_ds=None, nsx_api_public_endpoint_url=None, nfs_mode=None, cloud_password=None, sddc_networks=None, clusters=None, cloud_username=None, deployment_type=None, pop_agent_xeni_connection=None, nsx_mgr_management_ip=None, nsx_cloud_audit=None, esx_cluster_id=None, mgw_id=None, vc_url=None, esx_hosts=None, cloud_user_group=None, management_rp=None, witness_availability_zone=None, sddc_desired_state=None, sddc_size=None, cvds_enabled=None, nsx_controller_ips=None, two_hostname_vc_deployment=None, esx_host_subnet=None, sso_domain=None, region=None, dns_with_management_vm_private_ip=None, vc_public_ip=None, psc_ip=None, nsxt=None, key_provider=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, vc_containerized_permissions_enabled=None, custom_properties=None, provider='AWS', vc_management_ip=None, msft_license_config=None, nsx_native_client=None, vc_instance_id=None, vc_oauth_client=None, skip_creating_vxlan=None, sddc_manifest=None, vxlan_subnet=None, sddc_security=None, sddc_id=None, outpost_config=None, nsx_mgr_login_url=None, vc_break_glass_url=None, nsx_cloud_admin=None, nsxt_addons=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • backup_restore_bucket (str or None) –

  • public_ip_pool (list of SddcPublicIp or None) –

  • vpc_info (VpcInfo or None) –

  • mgw_public_ip_pool (list of SddcPublicIp or None) –

  • kms_vpc_endpoint (KmsVpcEndpoint or None) –

  • max_num_public_ip (long or None) – maximum number of public IP that user can allocate.

  • esx_instance_profile (InstanceProfileInfo or None) –

  • account_link_sddc_config (list of SddcLinkConfig or None) –

  • vsan_encryption_config (VsanEncryptionConfig or None) –

  • nsx_user_client (CspOauthClient or None) –

  • vpc_info_peered_agent (VpcInfo or None) –

  • nsx_service_client (CspOauthClient or None) –

  • vc_ip (str or None) – (deprecated)

  • mgmt_appliance_network_name (str or None) – Name for management appliance network.

  • nsx_mgr_url (str or None) – URL of the NSX Manager

  • vlcm_enabled (bool or None) – This flag determines whether vLCM is enabled on this sddc or not.

  • nsx_cloud_audit_password (str or None) – NSX cloud audit Password

  • vc_csp_login_status (str or None) – vCenter to csp federation status.

  • nsx_cloud_admin_password (str or None) – NSX cloud admin password

  • management_ds (str or None) – The ManagedObjectReference of the management Datastore

  • nsx_api_public_endpoint_url (str or None) – nsx api entire base url

  • nfs_mode (bool or None) – Nfs Mode Flag, for nfs mounting.

  • cloud_password (str or None) – Password for vCenter SDDC administrator

  • sddc_networks (list of str or None) –

  • clusters (list of Cluster or None) – List of clusters in the SDDC.

  • cloud_username (str or None) – Username for vCenter SDDC administrator

  • deployment_type (str or None) –

    Possible values are:

    Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.

  • pop_agent_xeni_connection (PopAgentXeniConnection or None) –

  • nsx_mgr_management_ip (str or None) – NSX Manager internal management IP

  • nsx_cloud_audit (str or None) – NSX cloud audit user name

  • esx_cluster_id (str or None) – Cluster Id to add ESX workflow

  • mgw_id (str or None) – Management Gateway Id

  • vc_url (str or None) – URL of the vCenter server

  • esx_hosts (list of AwsEsxHost or None) –

  • cloud_user_group (str or None) – Group name for vCenter SDDC administrator

  • management_rp (str or None) –

  • witness_availability_zone (str or None) – Availability zone where the witness node is provisioned for a MultiAZ SDDC. This is null for a SingleAZ SDDC.

  • sddc_desired_state (bool or None) – Whether this sddc is maintained by its desired state documents.

  • sddc_size (SddcSize or None) –

  • cvds_enabled (bool or None) – This flag determines whether CVDS is enabled on this sddc or not.

  • nsx_controller_ips (list of str or None) – List of Controller IPs

  • two_hostname_vc_deployment (bool or None) – Marks that the SDDC VC should be deployed with two hostnames.

  • esx_host_subnet (str or None) – ESX host subnet

  • sso_domain (str or None) – The SSO domain name to use for vSphere users

  • region (str or None) – region in which sddc is deployed

  • dns_with_management_vm_private_ip (bool or None) – if true, use the private IP addresses to register DNS records for the management VMs

  • vc_public_ip (str or None) – vCenter public IP

  • psc_ip (str or None) – (deprecated)

  • nsxt (bool or None) – if true, NSX-T UI is enabled.

  • key_provider (list of KeyProviderData or None) – Key provider data.

  • psc_management_ip (str or None) – PSC internal management IP

  • psc_url (str or None) – URL of the PSC server

  • cgws (list of str or None) –

  • availability_zones (list of str or None) – Availability zones over which esx hosts are provisioned. MultiAZ SDDCs will have hosts provisioned over two availability zones while SingleAZ SDDCs will provision over one.

  • vc_containerized_permissions_enabled (bool or None) – Mark if Containerized Permissions has been enabled on vCenter.

  • custom_properties ((dict of str and str) or None) –

  • provider (str) –

    Possible values are:

    Discriminator for additional properties

  • vc_management_ip (str or None) – vCenter internal management IP

  • msft_license_config (MsftLicensingConfig or None) – The Microsoft license status of this SDDC.

  • nsx_native_client (CspOauthClient or None) – NSX-T Native Oauth client for UI.

  • vc_instance_id (str or None) – unique id of the vCenter server

  • vc_oauth_client (CspOauthClient or None) – oAuth client for enabling federation on vCenter.

  • skip_creating_vxlan (bool or None) – skip creating vxlan for compute gateway for SDDC provisioning

  • sddc_manifest (SddcManifest or None) –

  • vxlan_subnet (str or None) – VXLAN IP subnet

  • sddc_security (SddcSecurity or None) –

  • sddc_id (str or None) – sddc identifier

  • outpost_config (OutpostConfig or None) – Outpost configuration of this SDDC.

  • nsx_mgr_login_url (str or None) – URL of the NSX Manager UI login for local user access

  • vc_break_glass_url (str or None) – Break-glass URL for non-federated login.

  • nsx_cloud_admin (str or None) – NSX cloud admin user name

  • nsxt_addons (NsxtAddons or None) –

property provider

Return the discriminator value

class com.vmware.vmc.model_client.AwsSubnet(connected_account_id=None, region_name=None, availability_zone=None, subnet_id=None, subnet_cidr_block=None, is_compatible=None, vpc_id=None, vpc_cidr_block=None, name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • connected_account_id (str or None) – The connected account ID this subnet is accessible through. This is an internal ID formatted as a UUID specific to Skyscraper.

  • region_name (str or None) – The region this subnet is in, usually in the form of country code, general location, and a number (ex. us-west-2).

  • availability_zone (str or None) – The availability zone this subnet is in, which should be the region name plus one extra letter (ex. us-west-2a).

  • subnet_id (str or None) – The subnet ID in AWS, provided in the form ‘subnet-######’.

  • subnet_cidr_block (str or None) – The CIDR block of the subnet, in the form of ‘#.#.#.#/#’.

  • is_compatible (bool or None) – Flag indicating whether this subnet is compatible. If true, this is a valid choice for the customer to deploy a SDDC in.

  • vpc_id (str or None) – The VPC ID the subnet resides in within AWS. Tends to be ‘vpc-#######’.

  • vpc_cidr_block (str or None) – The CIDR block of the VPC, in the form of ‘#.#.#.#/#’.

  • name (str or None) – Optional field (may not be provided by AWS), indicates the found name tag for the subnet.

class com.vmware.vmc.model_client.AwsWitnessEsx(instance_id=None, eni_info=None, enum_state=None, name=None, mac_address=None, esx_id=None, hostname=None, provider='AWS')

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
property provider

Return the discriminator value

class com.vmware.vmc.model_client.CloudProvider(provider='CloudProvider')

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

provider (str) – Name of the Cloud Provider

property provider

Return the discriminator value

class com.vmware.vmc.model_client.Cluster(cluster_capacity=None, esx_host_list=None, wcp_details=None, msft_license_config=None, cluster_state=None, esx_host_info=None, host_cpu_cores_count=None, partition_placement_group_info=None, cluster_id=None, availability_type=None, mgmt_rp_name=None, aws_kms_info=None, availability_zones=None, compute_rp_name=None, vsan_witness=None, custom_properties=None, cluster_name=None, vsan_version=None, hyper_threading_enabled=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
AVAILABILITY_TYPE_MULTI_AZ = 'MULTI_AZ'
AVAILABILITY_TYPE_SINGLE_AZ = 'SINGLE_AZ'
CLUSTER_STATE_ADDING_HOSTS = 'ADDING_HOSTS'
CLUSTER_STATE_DEPLOYING = 'DEPLOYING'
CLUSTER_STATE_FAILED = 'FAILED'
CLUSTER_STATE_READY = 'READY'
class com.vmware.vmc.model_client.ClusterConfig(host_cpu_cores_count=None, host_instance_type=None, storage_capacity=None, availability_zones=None, msft_license_config=None, num_hosts=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
HOST_INSTANCE_TYPE_I3EN_METAL = 'i3en.metal'
HOST_INSTANCE_TYPE_I3_METAL = 'i3.metal'
HOST_INSTANCE_TYPE_I4I_METAL = 'i4i.metal'
HOST_INSTANCE_TYPE_R5_METAL = 'r5.metal'
class com.vmware.vmc.model_client.ClusterReconfigureParams(storage_capacity=None, bias=None, num_hosts=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • storage_capacity (long or None) – The final desired storage capacity after reconfiguring the cluster in GiB. format: int64

  • bias (str or None) – Bias value as obtained from the storage constraints call.

  • num_hosts (long) – Number of hosts in the cluster after reconfiguring. format: int32

class com.vmware.vmc.model_client.ComputeGatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, logical_networks=None, nat_rules=None, l2_vpn=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • public_ip (SddcPublicIp or None) –

  • primary_dns (str or None) –

  • secondary_dns (str or None) –

  • firewall_rules (list of FirewallRule or None) –

  • vpns (list of Vpn or None) –

  • logical_networks (list of LogicalNetwork or None) –

  • nat_rules (list of NatRule or None) –

  • l2_vpn (vmware.vapi.struct.VapiStruct or None) –

class com.vmware.vmc.model_client.ConfigSpec(powered_by_outpost_available=None, expiry_in_days=None, sddc_sizes=None, availability=None, powered_by=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a configuration spec for any sddc provision operation.

Tip

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

Parameters

  • powered_by_outpost_available (bool or None) – Indicates if this org supports deployments that are powered by VMC on outposts

  • expiry_in_days (long or None) – Indicates after how many days the sddc should expire

  • sddc_sizes (list of str or None) –

  • availability ((dict of str and list of InstanceTypeConfig) or None) – Map of region to instance types available in that region

  • powered_by ((dict of str and list of PoweredByInstanceTypeConfig) or None) – Map of region to instance types available for the powered by type.

class com.vmware.vmc.model_client.ConnectivityAgentValidation(source=None, path=None, type=None, ports=None, pktsize=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
SOURCE_SRM = 'SRM'
SOURCE_VCENTER = 'VCENTER'
SOURCE_VR = 'VR'
TYPE_CONNECTIVITY = 'CONNECTIVITY'
TYPE_CURL = 'CURL'
TYPE_DNS = 'DNS'
TYPE_PING = 'PING'
TYPE_TRACEROUTE = 'TRACEROUTE'
class com.vmware.vmc.model_client.ConnectivityValidationGroup(id=None, name=None, sub_groups=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
ID_DRAAS = 'DRAAS'
ID_HLM = 'HLM'
class com.vmware.vmc.model_client.ConnectivityValidationGroups(groups=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

groups (list of ConnectivityValidationGroup or None) – List of groups.

class com.vmware.vmc.model_client.ConnectivityValidationInput(id=None, value=None, label=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
ID_HOSTNAME = 'HOSTNAME'
ID_HOSTNAME_OR_IP = 'HOSTNAME_OR_IP'
ID_HOST_IP = 'HOST_IP'
class com.vmware.vmc.model_client.ConnectivityValidationSubGroup(inputs=None, tests=None, label=None, help=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
ID_ACTIVE_DIRECTORY = 'ACTIVE_DIRECTORY'
ID_DRAAS_ONPREM_PSC = 'DRAAS_ONPREM_PSC'
ID_DRAAS_ONPREM_SRM = 'DRAAS_ONPREM_SRM'
ID_DRAAS_ONPREM_VCENTER = 'DRAAS_ONPREM_VCENTER'
ID_DRAAS_ONPREM_VR = 'DRAAS_ONPREM_VR'
ID_ONPREM_ESX = 'ONPREM_ESX'
ID_ONPREM_PSC = 'ONPREM_PSC'
ID_ONPREM_VCENTER = 'ONPREM_VCENTER'
ID_PRIMARY_DNS = 'PRIMARY_DNS'
ID_SECONDARY_DNS = 'SECONDARY_DNS'
class com.vmware.vmc.model_client.CspOauthClient(redirect_uris=None, access_token_ttl=None, redirect_uri=None, grant_types=None, org_id=None, secret=None, refresh_token_ttl=None, resource_link=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • redirect_uris (list of str or None) –

  • access_token_ttl (long or None) –

  • redirect_uri (str or None) –

  • grant_types (list of str or None) –

  • org_id (str or None) –

  • secret (str or None) – The Oauth client secret.

  • refresh_token_ttl (long or None) –

  • resource_link (str or None) –

  • id (str) – The Oauth client ID.

class com.vmware.vmc.model_client.CustomerEniInfo(secondary_ip_addresses=None, eni_id=None, primary_ip_address=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Indicates a single cross-account ENI and its characteristics.

Tip

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

Parameters

  • secondary_ip_addresses (list of str or None) – Indicates list of secondary IP created for this ENI.

  • eni_id (str or None) – Interface ID on customer account.

  • primary_ip_address (str or None) – Indicates primary address of the ENI.

class com.vmware.vmc.model_client.EbsBackedVsanConfig(instance_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

information for EBS-backed VSAN configuration

Tip

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

Parameters

instance_type (str or None) – instance type for EBS-backed VSAN configuration

class com.vmware.vmc.model_client.EnablementInfo(enabled=None, name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • enabled (bool) –

  • name (str) – Add-on name, for example “hcx”, “drass”, skynet”. If it is “default”, the value of enabled is for default settings of future add-ons.

class com.vmware.vmc.model_client.EniInfo(secondary_ips=None, attachment_id=None, association_id=None, vmk_id=None, device_index=None, security_group_id=None, instance_id=None, subnet_id=None, public_ips=None, private_ip=None, mac_address=None, source_dest_check_false=None, portgroup=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Information of the x-eni created.

Tip

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

Parameters

  • secondary_ips (list of str or None) – secondary private ips to be assigned.

  • attachment_id (str or None) – Id of the attachment, it is used to detach eni from instance.

  • association_id (str or None) – Id of the association for branch ENI, it is used to disassociate branch eni from trunk eni.

  • vmk_id (str or None) – The vmknic id or null if the ENI does not mapped to a vmknic.

  • device_index (long or None) – index of eni device..

  • security_group_id (str or None) – Security Group of Eni.

  • instance_id (str or None) – Id of the instance to be attached.

  • subnet_id (str or None) – Subnet it belongs to.

  • public_ips (list of str or None) – public ips to be associated with the secondary private ips.

  • private_ip (str or None) – Private ip of eni.

  • mac_address (str or None) – Mac address of nic.

  • source_dest_check_false (bool or None) – Whether to set sourceDestCheck as false..

  • portgroup (str or None) – The portgroup name or null if the ENI does not mapped to a portgroup.

  • id (str or None) – Interface ID.

class com.vmware.vmc.model_client.EntityCapacity(storage_capacity_gib=None, memory_capacity_gib=None, total_number_of_cores=None, number_of_ssds=None, cpu_capacity_ghz=None, number_of_sockets=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Decribes the capacity of a given entity.

Tip

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

Parameters

  • storage_capacity_gib (long or None) – The storage capacity for the given entity in GiB.

  • memory_capacity_gib (long or None) – The memory capacity for the given entity in GiB.

  • total_number_of_cores (long or None) – The number of CPU cores for the given entity.

  • number_of_ssds (long or None) – The number of SSDs for the given entity.

  • cpu_capacity_ghz (float or None) – The CPU capacity for the given entity in Ghz.

  • number_of_sockets (long or None) – The number of sockets for the given entity.

class com.vmware.vmc.model_client.ErrorResponse(status=None, path=None, retryable=None, error_code=None, error_messages=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • status (long) – HTTP status code

  • path (str) – Originating request URI

  • retryable (bool) – If true, client should retry operation

  • error_code (str) – unique error code

  • error_messages (list of str) – localized error messages

class com.vmware.vmc.model_client.EsxConfig(availability_zone=None, strict_placement=None, cluster_id=None, esxs=None, num_hosts=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • availability_zone (str or None) – Availability zone where the hosts should be provisioned. (Can be specified only for privileged host operations).

  • strict_placement (bool or None) – An option to indicate if the host needs to be strictly placed in a placement group. Fail the operation otherwise.

  • cluster_id (str or None) – An optional cluster id if the esxs operation has to be on a specific cluster.

  • esxs (list of str or None) – An optional list of ESX IDs to remove. format: UUID

  • num_hosts (long) –

class com.vmware.vmc.model_client.EsxHost(availability_zone=None, esx_id=None, durable_host_name=None, state_last_updated=None, name=None, custom_properties=None, hostname=None, provider='EsxHost', instance_type=None, mac_address=None, esx_state=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
ESX_STATE_ADDING_TO_VCENTER = 'ADDING_TO_VCENTER'
ESX_STATE_DELETED = 'DELETED'
ESX_STATE_DELETING = 'DELETING'
ESX_STATE_DELETING_FROM_VCENTER = 'DELETING_FROM_VCENTER'
ESX_STATE_DEPLOYING = 'DEPLOYING'
ESX_STATE_FAILED = 'FAILED'
ESX_STATE_INITIALIZING = 'INITIALIZING'
ESX_STATE_PENDING_CLOUD_DELETION = 'PENDING_CLOUD_DELETION'
ESX_STATE_PROVISIONED = 'PROVISIONED'
ESX_STATE_READY = 'READY'
property provider

Return the discriminator value

class com.vmware.vmc.model_client.EsxHostInfo(instance_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

instance_type (str or None) – Backing cloud provider instance type for cluster.

class com.vmware.vmc.model_client.EsxNicInfo(ip=None, mac=None, vlan=None, gateway=None, net_stack=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • ip (str or None) –

  • mac (str or None) –

  • vlan (str or None) –

  • gateway (str or None) –

  • net_stack (str or None) –

class com.vmware.vmc.model_client.FirewallRule(rule_type=None, application_ids=None, name=None, rule_interface=None, destination=None, id=None, destination_scope=None, source=None, source_scope=None, services=None, action=None, revision=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • rule_type (str or None) –

    Possible values are:

  • application_ids (list of str or None) –

  • name (str or None) –

  • rule_interface (str or None) – Deprecated, left for backwards compatibility. Remove once UI stops using it.

  • destination (str or None) – Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated list of those entries. If not specified, defaults to ‘any’.

  • id (str or None) –

  • destination_scope (FirewallRuleScope or None) –

  • source (str or None) – Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated list of those entries. If not specified, defaults to ‘any’.

  • source_scope (FirewallRuleScope or None) –

  • services (list of FirewallService or None) – list of protocols and ports for this firewall rule

  • action (str or None) –

    Possible values are:

  • revision (long or None) – current revision of the list of firewall rules, used to protect against concurrent modification (first writer wins) 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.

ACTION_ALLOW = 'ALLOW'
ACTION_DENY = 'DENY'
RULE_TYPE_DEFAULT = 'DEFAULT'
RULE_TYPE_USER = 'USER'
class com.vmware.vmc.model_client.FirewallRuleScope(grouping_object_ids=None, vnic_group_ids=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Optional for FirewallRule. If not specified, defaults to ‘any’.

Tip

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

Parameters
VNIC_GROUP_IDS_EXTERNAL = 'external'
VNIC_GROUP_IDS_INTERNAL = 'internal'
VNIC_GROUP_IDS_VNIC_INDEX_0 = 'vnic-index-0'
VNIC_GROUP_IDS_VNIC_INDEX_1 = 'vnic-index-1'
VNIC_GROUP_IDS_VNIC_INDEX_2 = 'vnic-index-2'
VNIC_GROUP_IDS_VNIC_INDEX_3 = 'vnic-index-3'
VNIC_GROUP_IDS_VNIC_INDEX_4 = 'vnic-index-4'
VNIC_GROUP_IDS_VNIC_INDEX_5 = 'vnic-index-5'
VNIC_GROUP_IDS_VNIC_INDEX_6 = 'vnic-index-6'
VNIC_GROUP_IDS_VNIC_INDEX_7 = 'vnic-index-7'
VNIC_GROUP_IDS_VNIC_INDEX_8 = 'vnic-index-8'
VNIC_GROUP_IDS_VNIC_INDEX_9 = 'vnic-index-9'
VNIC_GROUP_IDS_VSE = 'vse'
class com.vmware.vmc.model_client.FirewallService(protocol=None, ports=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • protocol (str or None) – protocol name, such as ‘tcp’, ‘udp’ etc.

  • ports (list of str or None) – a list of port numbers and port ranges, such as {80, 91-95, 99}. If not specified, defaults to ‘any’.

class com.vmware.vmc.model_client.GatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Describes common properties for MGW and CGW configuration templates

Tip

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

Parameters

  • public_ip (SddcPublicIp or None) –

  • primary_dns (str or None) –

  • secondary_dns (str or None) –

  • firewall_rules (list of FirewallRule or None) –

  • vpns (list of Vpn or None) –

class com.vmware.vmc.model_client.GlcmBundle(s3_bucket=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

the GlcmBundle used for deploying the sddc

Tip

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

Parameters

  • s3_bucket (str or None) – the glcmbundle’s s3 bucket

  • id (str or None) – the glcmbundle’s id

class com.vmware.vmc.model_client.InstanceProfileInfo(role_name=None, instance_profile_name=None, policy_name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • role_name (str or None) –

  • instance_profile_name (str or None) –

  • policy_name (str or None) –

class com.vmware.vmc.model_client.InstanceTypeBasicConfig(vsan_esa_supported=None, display_name=None, description=None, instance_type=None, entity_capacity=None, label=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a structure for basic instance type config.

Tip

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

Parameters

  • vsan_esa_supported (bool or None) – Boolean to indicate whether clusters and SDDCs using this instance type support vSAN ESA.

  • display_name (str or None) – Display name of instance_type.

  • description (str or None) – Description of the instance_type.

  • instance_type (str or None) – Instance type name.

  • entity_capacity (EntityCapacity or None) – The capacity of the given instance type.

  • label (str or None) – Label for instance_type.

class com.vmware.vmc.model_client.InstanceTypeConfig(vsan_esa_supported=None, display_name=None, description=None, instance_type=None, entity_capacity=None, label=None, instance_provisioning_error_cause=None, supported_cpu_cores=None, hosts=None, cpu_cores=None, hyper_threading_supported=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a structure for instance type config

Tip

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

Parameters

  • vsan_esa_supported (bool or None) – Boolean to indicate whether clusters and SDDCs using this instance type support vSAN ESA.

  • display_name (str or None) – Display name of instance_type.

  • description (str or None) – Description of the instance_type.

  • instance_type (str or None) – Instance type name.

  • entity_capacity (EntityCapacity or None) – The capacity of the given instance type.

  • label (str or None) – Label for instance_type.

  • instance_provisioning_error_cause (str or None) – Error due to which instance provisioning is restricted on the cluster.

  • supported_cpu_cores ((dict of str and list of long) or None) – Map of host count vs valid cpu core values for the given instance type.

  • hosts (list of long or None) – Array of number of hosts allowed for this operation. Range of hosts user can select for sddc provision

  • cpu_cores (list of long or None) – Array of valid cpu cores values for the given instance type.

  • hyper_threading_supported (bool or None) – Boolean to indicate whether hyperThreading is supported for an instance type.

class com.vmware.vmc.model_client.KeyProviderData(provider_type=None, native_spec_key_material=None, is_default_key_provider=None, is_host_key_provider=None, provider=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • provider_type (str or None) –

  • native_spec_key_material (NativeSpecKeyMaterial or None) –

  • is_default_key_provider (bool or None) –

  • is_host_key_provider (bool or None) –

  • provider (str or None) –

class com.vmware.vmc.model_client.KmsVpcEndpoint(vpc_endpoint_id=None, network_interface_ids=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • vpc_endpoint_id (str or None) – The identifier of the VPC endpoint created to AWS Key Management Service

  • network_interface_ids (list of str or None) –

class com.vmware.vmc.model_client.L2Vpn(enabled=None, sites=None, listener_ip=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • enabled (bool or None) – Enable (true) or disable (false) L2 VPN.

  • sites (list of Site) – Array of L2 vpn site config.

  • listener_ip (str or None) – Public uplink ip address. IP of external interface on which L2VPN service listens to.

class com.vmware.vmc.model_client.LinkRequest(tracking_task=None, expiration_date=None, template_url=None, template_execution_url=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • tracking_task (str or None) – The UUID of the task we’re using to track the status of this link request. format: uuid

  • expiration_date (datetime.datetime or None) – The time at which the template URL expires. Once this has elapsed, the request is no longer invokable. format: date-time

  • template_url (str or None) – The constructed template URL. Just shows the contents of the template for viewing/download.

  • template_execution_url (str or None) – The final URL to be given to the user as a “click here to start” link.

class com.vmware.vmc.model_client.LogicalNetwork(subnet_cidr=None, name=None, gateway_ip=None, dhcp_enabled=None, dhcp_ip_range=None, tunnel_id=None, id=None, network_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • subnet_cidr (str or None) – the subnet cidr

  • name (str or None) – name of the network

  • gateway_ip (str or None) – gateway ip of the logical network

  • dhcp_enabled (str or None) – if ‘true’ - enabled; if ‘false’ - disabled

  • dhcp_ip_range (str or None) – ip range within the subnet mask, range delimiter is ‘-’ (example 10.118.10.130-10.118.10.140)

  • tunnel_id (long or None) – tunnel id of extended network format: int32

  • id (str or None) –

  • network_type (str or None) –

    Possible values are:

NETWORK_TYPE_EXTENDED = 'EXTENDED'
NETWORK_TYPE_HOSTED = 'HOSTED'
NETWORK_TYPE_ROUTED = 'ROUTED'
class com.vmware.vmc.model_client.MaintenanceWindow(day_of_week=None, hour_of_day=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
DAY_OF_WEEK_FRIDAY = 'FRIDAY'
DAY_OF_WEEK_MONDAY = 'MONDAY'
DAY_OF_WEEK_SATURDAY = 'SATURDAY'
DAY_OF_WEEK_SUNDAY = 'SUNDAY'
DAY_OF_WEEK_THURSDAY = 'THURSDAY'
DAY_OF_WEEK_TUESDAY = 'TUESDAY'
DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY'
class com.vmware.vmc.model_client.MaintenanceWindowEntry(in_maintenance_window=None, reservation_schedule=None, reservation_id=None, in_maintenance_mode=None, sddc_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • in_maintenance_window (bool or None) – true if the SDDC is in the defined Mainentance Window

  • reservation_schedule (ReservationSchedule or None) –

  • reservation_id (str or None) – ID for reservation format: uuid

  • in_maintenance_mode (bool or None) – true if the SDDC is currently undergoing maintenance

  • sddc_id (str or None) – SDDC ID for this reservation format: uuid

class com.vmware.vmc.model_client.MaintenanceWindowGet(day_of_week=None, hour_of_day=None, duration_min=None, version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
DAY_OF_WEEK_FRIDAY = 'FRIDAY'
DAY_OF_WEEK_MONDAY = 'MONDAY'
DAY_OF_WEEK_SATURDAY = 'SATURDAY'
DAY_OF_WEEK_SUNDAY = 'SUNDAY'
DAY_OF_WEEK_THURSDAY = 'THURSDAY'
DAY_OF_WEEK_TUESDAY = 'TUESDAY'
DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY'
class com.vmware.vmc.model_client.ManagementGatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, subnet_cidr=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • public_ip (SddcPublicIp or None) –

  • primary_dns (str or None) –

  • secondary_dns (str or None) –

  • firewall_rules (list of FirewallRule or None) –

  • vpns (list of Vpn or None) –

  • subnet_cidr (str or None) – mgw network subnet cidr

class com.vmware.vmc.model_client.MapZonesRequest(connected_account_id=None, org_id=None, petronas_regions_to_map=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • connected_account_id (str or None) – The connected account ID to remap. This is a standard UUID.

  • org_id (str or None) – The org ID to remap in. This is a standard UUID.

  • petronas_regions_to_map (list of str or None) – A list of Petronas regions to map.

class com.vmware.vmc.model_client.Metadata(timestamp=None, cycle_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

metadata of the sddc manifest

Tip

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

Parameters

  • timestamp (str or None) – the timestamp for the bundle

  • cycle_id (str or None) – the cycle id

class com.vmware.vmc.model_client.MsftLicensingConfig(mssql_licensing=None, academic_license=None, windows_licensing=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
MSSQL_LICENSING_CUSTOMER_SUPPLIED = 'CUSTOMER_SUPPLIED'
MSSQL_LICENSING_DISABLED = 'DISABLED'
MSSQL_LICENSING_ENABLED = 'ENABLED'
WINDOWS_LICENSING_CUSTOMER_SUPPLIED = 'CUSTOMER_SUPPLIED'
WINDOWS_LICENSING_DISABLED = 'DISABLED'
WINDOWS_LICENSING_ENABLED = 'ENABLED'
class com.vmware.vmc.model_client.NatRule(rule_type=None, protocol=None, name=None, internal_ports=None, public_ports=None, public_ip=None, internal_ip=None, action=None, id=None, revision=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • rule_type (str or None) –

  • protocol (str or None) –

  • name (str or None) –

  • internal_ports (str or None) –

  • public_ports (str or None) –

  • public_ip (str or None) –

  • internal_ip (str or None) –

  • action (str or None) –

    Possible values are:

  • id (str or None) –

  • revision (long or None) – current revision of the list of nat rules, used to protect against concurrent modification (first writer wins) 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.

ACTION_DNAT = 'dnat'
ACTION_SNAT = 'snat'
class com.vmware.vmc.model_client.NativeSpecKeyMaterial(key_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

key_id (str or None) –

class com.vmware.vmc.model_client.NetworkTemplate(management_gateway_templates=None, compute_gateway_templates=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
class com.vmware.vmc.model_client.NewCredentials(username=None, password=None, name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • username (str) – Username of the credentials

  • password (str) – Password associated with the credentials

  • name (str) – Name of the credentials

class com.vmware.vmc.model_client.NsxtAddons(enable_nsx_advanced_addon=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Details the state of different NSX add-ons.

Tip

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

Parameters

enable_nsx_advanced_addon (bool or None) – Indicates whether NSX Advanced addon is enabled or disabled.

class com.vmware.vmc.model_client.OfferInstancesHolder(on_demand=None, offers=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Holder for the offer instances.

Tip

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

Parameters
class com.vmware.vmc.model_client.OnDemandOfferInstance(product=None, product_type=None, name=None, currency=None, region=None, unit_price=None, monthly_cost=None, version=None, type=None, description=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Holder for the on-demand offer instance.

Tip

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

Parameters

  • product (str) –

  • product_type (str or None) – Deprecated. Please use product and type fields instead.

  • name (str) –

  • currency (str) –

  • region (str) –

  • unit_price (str) –

  • monthly_cost (str) –

  • version (str) –

  • type (str) –

  • description (str) –

class com.vmware.vmc.model_client.OrgProperties(values=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

values ((dict of str and str) or None) – A map of string properties to values.

class com.vmware.vmc.model_client.OrgSellerInfo(seller_account_id=None, seller=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • seller_account_id (str or None) – The accountid for this org for the seller-of-record. NILLABLE.

  • seller (str or None) – The seller-of-record for the current organization. For example AWS or VMWARE

class com.vmware.vmc.model_client.Organization(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, org_type=None, display_name=None, name=None, org_seller_info=None, project_state=None, properties=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • updated (datetime.datetime) –

  • user_id (str) – User id that last updated this record

  • updated_by_user_id (str) – User id that last updated this record

  • created (datetime.datetime) –

  • version (long) – Version of this entity format: int32

  • updated_by_user_name (str or None) – User name that last updated this record

  • user_name (str) – User name that last updated this record

  • id (str) – Unique ID for this entity

  • org_type (str or None) – ORG_TYPE to be associated with the org

  • display_name (str or None) –

  • name (str or None) –

  • org_seller_info (OrgSellerInfo or None) –

  • project_state (str or None) –

    Possible values are:

  • properties (OrgProperties or None) –

PROJECT_STATE_CREATED = 'CREATED'
PROJECT_STATE_DELETED = 'DELETED'
class com.vmware.vmc.model_client.OutpostConfig(outpost_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

outpost_id (str or None) – Outpost ID

class com.vmware.vmc.model_client.PartitionPlacementGroupInfo(partition_group_names=None, availability_zone=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • partition_group_names (list of str or None) –

  • availability_zone (str or None) – The availability zone of the placement group.

class com.vmware.vmc.model_client.PaymentMethodInfo(type=None, default_flag=None, payment_method_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • type (str or None) –

  • default_flag (bool or None) –

  • payment_method_id (str or None) –

class com.vmware.vmc.model_client.PopAgentXeniConnection(default_subnet_route=None, eni_info=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • default_subnet_route (str or None) – The gateway route ip fo the subnet.

  • eni_info (EniInfo or None) –

class com.vmware.vmc.model_client.PopAmiInfo(instance_type=None, region=None, id=None, name=None, type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • instance_type (str or None) – instance type of the esx ami

  • region (str or None) – the region of the esx ami

  • id (str or None) – the ami id for the esx

  • name (str or None) – the name of the esx ami

  • type (str or None) –

    Possible values are:

    PoP AMI type. CENTOS: a Centos AMI; POP: a PoP AMI.

TYPE_CENTOS = 'CENTOS'
TYPE_POP = 'POP'
class com.vmware.vmc.model_client.PopInfo(ami_infos=None, manifest_version=None, service_infos=None, created_at=None, os_type=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Present a SDDC PoP information.

Tip

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

Parameters

  • ami_infos (dict of str and PopAmiInfo) – A map of [region name of PoP / PoP-AMI]:[PopAmiInfo].

  • manifest_version (str or None) – version of the manifest.

  • service_infos ((dict of str and PopServiceInfo) or None) – A map of [service type]:[PopServiceInfo]

  • created_at (datetime.datetime or None) – The PopInfo (or PoP AMI) created time. Using ISO 8601 date-time pattern. format: date-time

  • os_type (str or None) –

    Possible values are:

    Type of OS: CENTOS or AMAZON(Amazon Linux 2) or PHOTON

  • id (str or None) – UUID of the PopInfo format: UUID

OS_TYPE_AMAZON = 'AMAZON'
OS_TYPE_CENTOS = 'CENTOS'
OS_TYPE_PHOTON = 'PHOTON'
class com.vmware.vmc.model_client.PopServiceInfo(cln=None, version=None, build=None, service=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • cln (str or None) – The service change set number.

  • version (str or None) – The service API version.

  • build (str or None) – The service build number.

  • service (str or None) – PoP related services (including os platform and JRE).

class com.vmware.vmc.model_client.PoweredByInstanceTypeConfig(vsan_esa_supported=None, display_name=None, description=None, instance_type=None, entity_capacity=None, label=None, instance_provisioning_error_cause=None, supported_cpu_cores=None, hosts=None, cpu_cores=None, hyper_threading_supported=None, powered_by_id=None, powered_by_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a structure for powered by instance type configuration.

Tip

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

Parameters

  • vsan_esa_supported (bool or None) – Boolean to indicate whether clusters and SDDCs using this instance type support vSAN ESA.

  • display_name (str or None) – Display name of instance_type.

  • description (str or None) – Description of the instance_type.

  • instance_type (str or None) – Instance type name.

  • entity_capacity (EntityCapacity or None) – The capacity of the given instance type.

  • label (str or None) – Label for instance_type.

  • instance_provisioning_error_cause (str or None) – Error due to which instance provisioning is restricted on the cluster.

  • supported_cpu_cores ((dict of str and list of long) or None) – Map of host count vs valid cpu core values for the given instance type.

  • hosts (list of long or None) – Array of number of hosts allowed for this operation. Range of hosts user can select for sddc provision

  • cpu_cores (list of long or None) – Array of valid cpu cores values for the given instance type.

  • hyper_threading_supported (bool or None) – Boolean to indicate whether hyperThreading is supported for an instance type.

  • powered_by_id (str or None) – ID of the powered by configuration.

  • powered_by_type (str or None) –

    Possible values are:

    Represents the type of powered by instance type configuration.

POWERED_BY_TYPE_OUTPOST = 'OUTPOST'
class com.vmware.vmc.model_client.ProvisionSpec(provider=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a provisioning spec for a sddc

Tip

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

Parameters

provider ((dict of str and SddcConfigSpec) or None) – Map of provider to sddc config spec

class com.vmware.vmc.model_client.RequestDetail(aws_quota_request_id=None, detail_status=None, resolved_at=None, desired_value=None, aws_support_case_status=None, aws_support_case_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
DETAIL_STATUS_DENIED = 'DENIED'
DETAIL_STATUS_ERROR = 'ERROR'
DETAIL_STATUS_NEW = 'NEW'
DETAIL_STATUS_PENDINGSUBMIT = 'PENDINGSUBMIT'
DETAIL_STATUS_PENDINGVERFICATION = 'PENDINGVERFICATION'
DETAIL_STATUS_RESOLVED = 'RESOLVED'
DETAIL_STATUS_SUBMITTED = 'SUBMITTED'
class com.vmware.vmc.model_client.Reservation(duration=None, rid=None, create_time=None, start_time=None, metadata=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • duration (long or None) – Duration - required for reservation in maintenance window format: int64

  • rid (str or None) – Reservation ID format: uuid

  • create_time (str or None) – Optional

  • start_time (datetime.datetime or None) – Start time of a reservation format: date-time

  • metadata ((dict of str and str) or None) – Optional

class com.vmware.vmc.model_client.ReservationInMw(rid=None, week_of=None, create_time=None, metadata=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • rid (str or None) – Reservation ID format: uuid

  • week_of (str or None) – SUNDAY of the week that maintenance is scheduled, ISO format date

  • create_time (datetime.datetime or None) – Optional format: date-time

  • metadata ((dict of str and str) or None) – Optional

class com.vmware.vmc.model_client.ReservationSchedule(day_of_week=None, hour_of_day=None, duration_min=None, version=None, reservations=None, reservations_mw=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
DAY_OF_WEEK_FRIDAY = 'FRIDAY'
DAY_OF_WEEK_MONDAY = 'MONDAY'
DAY_OF_WEEK_SATURDAY = 'SATURDAY'
DAY_OF_WEEK_SUNDAY = 'SUNDAY'
DAY_OF_WEEK_THURSDAY = 'THURSDAY'
DAY_OF_WEEK_TUESDAY = 'TUESDAY'
DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY'
class com.vmware.vmc.model_client.ReservationWindow(duration_hours=None, estimated_duration_hours_minimum=None, reservation_state=None, emergency=None, maintenance_properties=None, manifest_id=None, start_hour=None, sddc_id=None, start_date=None, estimated_duration_hours_maximum=None, reserve_id=None, metadata=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
RESERVATION_STATE_CANCELED = 'CANCELED'
RESERVATION_STATE_COMPLETED = 'COMPLETED'
RESERVATION_STATE_RUNNING = 'RUNNING'
RESERVATION_STATE_SCHEDULED = 'SCHEDULED'
RESERVATION_STATE_TERMINATED = 'TERMINATED'
class com.vmware.vmc.model_client.ReservationWindowMaintenanceProperties(status=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

status (str or None) – Status of upgrade, if any

class com.vmware.vmc.model_client.RouteTableInfo(name=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • name (str or None) – route table name

  • id (str or None) – route table id

class com.vmware.vmc.model_client.Sddc(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, name=None, sddc_state=None, expiration_date=None, org_id=None, sddc_type=None, provider=None, account_link_state=None, sddc_access_state=None, resource_config=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
PROVIDER_AWS = 'AWS'
PROVIDER_ZEROCLOUD = 'ZEROCLOUD'
SDDC_STATE_CANCELED = 'CANCELED'
SDDC_STATE_DELETED = 'DELETED'
SDDC_STATE_DELETING = 'DELETING'
SDDC_STATE_DEPLOYING = 'DEPLOYING'
SDDC_STATE_FAILED = 'FAILED'
SDDC_STATE_READY = 'READY'
SDDC_STATE_READY_FOR_GLCM_BRINGUP = 'READY_FOR_GLCM_BRINGUP'
class com.vmware.vmc.model_client.SddcChoice(display_text=None, value=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • display_text (str or None) – SDDC display name

  • value (str or None) – SDDC id

class com.vmware.vmc.model_client.SddcConfig(msft_license_config=None, account_link_config=None, vpc_cidr=None, skip_creating_vxlan=None, vxlan_subnet=None, size=None, outpost_id=None, storage_capacity=None, name=None, account_link_sddc_config=None, host_instance_type=None, region=None, sddc_id=None, sddc_template_id=None, sddc_type=None, vsan_version=None, provider='SddcConfig', sso_domain=None, num_hosts=None, deployment_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • msft_license_config (MsftLicensingConfig or None) – Indicates the desired licensing support, if any, of Microsoft software.

  • account_link_config (AccountLinkConfig or None) – The account linking configuration, we will keep this one and remove accountLinkSddcConfig finally.

  • vpc_cidr (str or None) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.

  • skip_creating_vxlan (bool or None) – skip creating vxlan for compute gateway for SDDC provisioning

  • vxlan_subnet (str or None) – VXLAN IP subnet in CIDR for compute gateway

  • size (str or None) –

    Possible values are:

    The size of the vCenter and NSX appliances. “large” sddcSize corresponds to a ‘large’ vCenter appliance and ‘large’ NSX appliance. ‘medium’ sddcSize corresponds to ‘medium’ vCenter appliance and ‘medium’ NSX appliance. Value defaults to ‘medium’.

  • outpost_id (str or None) – Outpost ID of the SDDC. Used only for outpost deployments.

  • storage_capacity (long or None) – The storage capacity value to be requested for the sddc primary cluster, in GiBs. If provided, instead of using the direct-attached storage, a capacity value amount of seperable storage will be used. format: int64

  • name (str) –

  • account_link_sddc_config (list of AccountLinkSddcConfig or None) – A list of the SDDC linking configurations to use.

  • host_instance_type (str or None) –

    Possible values are:

    The instance type for the esx hosts in the primary cluster of the SDDC.

  • region (str or None) –

  • sddc_id (str or None) – If provided, will be assigned as SDDC id of the provisioned SDDC. format: UUID

  • sddc_template_id (str or None) – If provided, configuration from the template will applied to the provisioned SDDC. format: UUID

  • sddc_type (str or None) – Denotes the sddc type , if the value is null or empty, the type is considered as default.

  • vsan_version (str or None) –

    Possible values are:

    The vSAN version to be used in the SDDC’s primary cluster.

  • provider (str) –

    Possible values are:

    Determines what additional properties are available based on cloud provider.

  • sso_domain (str or None) – The SSO domain name to use for vSphere users. If not specified, vmc.local will be used.

  • num_hosts (long) –

  • deployment_type (str or None) –

    Possible values are:

    Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is SingleAZ.

DEPLOYMENT_TYPE_MULTIAZ = 'MultiAZ'
DEPLOYMENT_TYPE_SINGLEAZ = 'SingleAZ'
HOST_INSTANCE_TYPE_I3EN_METAL = 'i3en.metal'
HOST_INSTANCE_TYPE_I3_METAL = 'i3.metal'
HOST_INSTANCE_TYPE_I4I_METAL = 'i4i.metal'
HOST_INSTANCE_TYPE_R5_METAL = 'r5.metal'
PROVIDER_AWS = 'AWS'
PROVIDER_ZEROCLOUD = 'ZEROCLOUD'
SIZE_LARGE = 'large'
SIZE_MEDIUM = 'medium'
SIZE_NSX_LARGE = 'nsx_large'
SIZE_NSX_SMALL = 'nsx_small'
VSAN_VERSION_NOVSAN = 'novsan'
VSAN_VERSION_VSAN1 = 'vsan1'
VSAN_VERSION_VSANESA = 'vsanesa'
property provider

Return the discriminator value

class com.vmware.vmc.model_client.SddcConfigSpec(sddc_type_config_spec=None, region_display_names=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a configuration spec for a sddc

Tip

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

Parameters

  • sddc_type_config_spec ((dict of str and ConfigSpec) or None) – Map of sddc type to config spec

  • region_display_names ((dict of str and str) or None) – The region name to display names mapping

class com.vmware.vmc.model_client.SddcConvertRequest(num_hosts=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Convert request body for SDDC

Tip

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

Parameters

num_hosts (long or None) – The total number of hosts in the SDDC after conversion.

class com.vmware.vmc.model_client.SddcId(sddc_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

sddc_id (str or None) – Sddc ID

class com.vmware.vmc.model_client.SddcInput(inputs=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

inputs (list of SddcList) –

class com.vmware.vmc.model_client.SddcLinkConfig(customer_subnet_ids=None, connected_account_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • customer_subnet_ids (list of str or None) –

  • connected_account_id (str or None) – Determines which connected customer account to link to

class com.vmware.vmc.model_client.SddcList(label=None, required=None, placeholder=None, name=None, choice=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • label (str or None) –

  • required (bool or None) –

  • placeholder (str or None) –

  • name (str or None) –

  • choice (list of SddcChoice or None) –

class com.vmware.vmc.model_client.SddcManifest(vmc_version=None, glcm_bundle=None, pop_info=None, vmc_internal_version=None, ebs_backed_vsan_config=None, vsan_witness_ami=None, esx_ami=None, esx_nsxt_ami=None, metadata=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Describes software components of the installed SDDC

Tip

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

Parameters

  • vmc_version (str or None) – the vmcVersion of the sddc for display

  • glcm_bundle (GlcmBundle or None) –

  • pop_info (PopInfo or None) –

  • vmc_internal_version (str or None) – the vmcInternalVersion of the sddc for internal use

  • ebs_backed_vsan_config (EbsBackedVsanConfig or None) –

  • vsan_witness_ami (AmiInfo or None) –

  • esx_ami (AmiInfo or None) –

  • esx_nsxt_ami (AmiInfo or None) –

  • metadata (Metadata or None) –

class com.vmware.vmc.model_client.SddcPatchRequest(name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Patch request body for SDDC

Tip

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

Parameters

name (str or None) – The new name of the SDDC to be changed to.

class com.vmware.vmc.model_client.SddcPublicIp(public_ip=None, name=None, allocation_id=None, dnat_rule_id=None, associated_private_ip=None, snat_rule_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • public_ip (str) –

  • name (str or None) –

  • allocation_id (str or None) –

  • dnat_rule_id (str or None) –

  • associated_private_ip (str or None) –

  • snat_rule_id (str or None) –

class com.vmware.vmc.model_client.SddcResourceConfig(vc_ip=None, mgmt_appliance_network_name=None, nsx_mgr_url=None, vlcm_enabled=None, nsx_cloud_audit_password=None, vc_csp_login_status=None, nsx_cloud_admin_password=None, management_ds=None, nsx_api_public_endpoint_url=None, nfs_mode=None, cloud_password=None, sddc_networks=None, clusters=None, cloud_username=None, deployment_type=None, pop_agent_xeni_connection=None, nsx_mgr_management_ip=None, nsx_cloud_audit=None, esx_cluster_id=None, mgw_id=None, vc_url=None, esx_hosts=None, cloud_user_group=None, management_rp=None, witness_availability_zone=None, sddc_desired_state=None, sddc_size=None, cvds_enabled=None, nsx_controller_ips=None, two_hostname_vc_deployment=None, esx_host_subnet=None, sso_domain=None, region=None, dns_with_management_vm_private_ip=None, vc_public_ip=None, psc_ip=None, nsxt=None, key_provider=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, vc_containerized_permissions_enabled=None, custom_properties=None, provider='SddcResourceConfig', vc_management_ip=None, msft_license_config=None, nsx_native_client=None, vc_instance_id=None, vc_oauth_client=None, skip_creating_vxlan=None, sddc_manifest=None, vxlan_subnet=None, sddc_security=None, sddc_id=None, outpost_config=None, nsx_mgr_login_url=None, vc_break_glass_url=None, nsx_cloud_admin=None, nsxt_addons=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • vc_ip (str or None) – (deprecated)

  • mgmt_appliance_network_name (str or None) – Name for management appliance network.

  • nsx_mgr_url (str or None) – URL of the NSX Manager

  • vlcm_enabled (bool or None) – This flag determines whether vLCM is enabled on this sddc or not.

  • nsx_cloud_audit_password (str or None) – NSX cloud audit Password

  • vc_csp_login_status (str or None) – vCenter to csp federation status.

  • nsx_cloud_admin_password (str or None) – NSX cloud admin password

  • management_ds (str or None) – The ManagedObjectReference of the management Datastore

  • nsx_api_public_endpoint_url (str or None) – nsx api entire base url

  • nfs_mode (bool or None) – Nfs Mode Flag, for nfs mounting.

  • cloud_password (str or None) – Password for vCenter SDDC administrator

  • sddc_networks (list of str or None) –

  • clusters (list of Cluster or None) – List of clusters in the SDDC.

  • cloud_username (str or None) – Username for vCenter SDDC administrator

  • deployment_type (str or None) –

    Possible values are:

    Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.

  • pop_agent_xeni_connection (PopAgentXeniConnection or None) –

  • nsx_mgr_management_ip (str or None) – NSX Manager internal management IP

  • nsx_cloud_audit (str or None) – NSX cloud audit user name

  • esx_cluster_id (str or None) – Cluster Id to add ESX workflow

  • mgw_id (str or None) – Management Gateway Id

  • vc_url (str or None) – URL of the vCenter server

  • esx_hosts (list of AwsEsxHost or None) –

  • cloud_user_group (str or None) – Group name for vCenter SDDC administrator

  • management_rp (str or None) –

  • witness_availability_zone (str or None) – Availability zone where the witness node is provisioned for a MultiAZ SDDC. This is null for a SingleAZ SDDC.

  • sddc_desired_state (bool or None) – Whether this sddc is maintained by its desired state documents.

  • sddc_size (SddcSize or None) –

  • cvds_enabled (bool or None) – This flag determines whether CVDS is enabled on this sddc or not.

  • nsx_controller_ips (list of str or None) – List of Controller IPs

  • two_hostname_vc_deployment (bool or None) – Marks that the SDDC VC should be deployed with two hostnames.

  • esx_host_subnet (str or None) – ESX host subnet

  • sso_domain (str or None) – The SSO domain name to use for vSphere users

  • region (str or None) – region in which sddc is deployed

  • dns_with_management_vm_private_ip (bool or None) – if true, use the private IP addresses to register DNS records for the management VMs

  • vc_public_ip (str or None) – vCenter public IP

  • psc_ip (str or None) – (deprecated)

  • nsxt (bool or None) – if true, NSX-T UI is enabled.

  • key_provider (list of KeyProviderData or None) – Key provider data.

  • psc_management_ip (str or None) – PSC internal management IP

  • psc_url (str or None) – URL of the PSC server

  • cgws (list of str or None) –

  • availability_zones (list of str or None) – Availability zones over which esx hosts are provisioned. MultiAZ SDDCs will have hosts provisioned over two availability zones while SingleAZ SDDCs will provision over one.

  • vc_containerized_permissions_enabled (bool or None) – Mark if Containerized Permissions has been enabled on vCenter.

  • custom_properties ((dict of str and str) or None) –

  • provider (str) –

    Possible values are:

    Discriminator for additional properties

  • vc_management_ip (str or None) – vCenter internal management IP

  • msft_license_config (MsftLicensingConfig or None) – The Microsoft license status of this SDDC.

  • nsx_native_client (CspOauthClient or None) – NSX-T Native Oauth client for UI.

  • vc_instance_id (str or None) – unique id of the vCenter server

  • vc_oauth_client (CspOauthClient or None) – oAuth client for enabling federation on vCenter.

  • skip_creating_vxlan (bool or None) – skip creating vxlan for compute gateway for SDDC provisioning

  • sddc_manifest (SddcManifest or None) –

  • vxlan_subnet (str or None) – VXLAN IP subnet

  • sddc_security (SddcSecurity or None) –

  • sddc_id (str or None) – sddc identifier

  • outpost_config (OutpostConfig or None) – Outpost configuration of this SDDC.

  • nsx_mgr_login_url (str or None) – URL of the NSX Manager UI login for local user access

  • vc_break_glass_url (str or None) – Break-glass URL for non-federated login.

  • nsx_cloud_admin (str or None) – NSX cloud admin user name

  • nsxt_addons (NsxtAddons or None) –

DEPLOYMENT_TYPE_MULTI_AZ = 'MULTI_AZ'
DEPLOYMENT_TYPE_SINGLE_AZ = 'SINGLE_AZ'
PROVIDER_AWS = 'AWS'
PROVIDER_ZEROCLOUD = 'ZEROCLOUD'
property provider

Return the discriminator value

class com.vmware.vmc.model_client.SddcSecurity(profile=None, hardened=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Details the sddc securtity profiles and Harden state.

Tip

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

Parameters
PROFILE_DEFAULT = 'PROFILE_DEFAULT'
PROFILE_PCI_COMMERCIAL = 'PROFILE_PCI_COMMERCIAL'
class com.vmware.vmc.model_client.SddcSize(vc_size=None, nsx_size=None, size=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Size of the SDDC

Tip

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

Parameters
NSX_SIZE_LARGE = 'large'
NSX_SIZE_MEDIUM = 'medium'
NSX_SIZE_SMALL = 'small'
SIZE_LARGE = 'LARGE'
SIZE_MEDIUM = 'MEDIUM'
SIZE_NSX_LARGE = 'NSX_LARGE'
SIZE_NSX_SMALL = 'NSX_SMALL'
VC_SIZE_LARGE = 'large'
VC_SIZE_MEDIUM = 'medium'
class com.vmware.vmc.model_client.SddcStateRequest(sddcs=None, states=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
STATES_CANCELED = 'CANCELED'
STATES_COMPLETED = 'COMPLETED'
STATES_RUNNING = 'RUNNING'
STATES_SCHEDULED = 'SCHEDULED'
class com.vmware.vmc.model_client.SddcTemplate(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, account_link_sddc_configs=None, state=None, network_template=None, name=None, source_sddc_id=None, org_id=None, sddc=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
STATE_APPLIED = 'APPLIED'
STATE_AVAILABLE = 'AVAILABLE'
STATE_DELETED = 'DELETED'
STATE_DELETING = 'DELETING'
STATE_FAILED = 'FAILED'
STATE_INITIALIZATION = 'INITIALIZATION'
STATE_INUSE = 'INUSE'
class com.vmware.vmc.model_client.ServiceError(default_message=None, original_service=None, localized_message=None, original_service_error_code=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Detailed service errors associated with a task.

Tip

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

Parameters

  • default_message (str or None) – Error message in English.

  • original_service (str or None) – The original service name of the error.

  • localized_message (str or None) – The localized message.

  • original_service_error_code (str or None) – The original error code of the service.

class com.vmware.vmc.model_client.ServiceQuotaRequest(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, requester_email=None, task_id=None, region=None, aws_account_number=None, org_id=None, reason=None, request_status=None, request_details=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • updated (datetime.datetime) –

  • user_id (str) – User id that last updated this record

  • updated_by_user_id (str) – User id that last updated this record

  • created (datetime.datetime) –

  • version (long) – Version of this entity format: int32

  • updated_by_user_name (str or None) – User name that last updated this record

  • user_name (str) – User name that last updated this record

  • id (str) – Unique ID for this entity

  • requester_email (str or None) –

  • task_id (str or None) – The task for running the service quota request.

  • region (str or None) – Region for the service quota

  • aws_account_number (str or None) –

  • org_id (str or None) – The org ID for this request. This is a standard UUID.

  • reason (str or None) – Reason for this quota increase

  • request_status (str or None) –

    Possible values are:

  • request_details ((dict of str and RequestDetail) or None) – service quota request item details

REQUEST_STATUS_DENIED = 'DENIED'
REQUEST_STATUS_ERROR = 'ERROR'
REQUEST_STATUS_NEW = 'NEW'
REQUEST_STATUS_PENDING = 'PENDING'
REQUEST_STATUS_RESOLVED = 'RESOLVED'
class com.vmware.vmc.model_client.Site(password=None, user_id=None, name=None, rx_bytes_on_local_subnet=None, secure_traffic=None, established_date=None, failure_message=None, dropped_tx_packets=None, dropped_rx_packets=None, tunnel_status=None, tx_bytes_from_local_subnet=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • password (str or None) – Site password.

  • user_id (str or None) – Site user id.

  • name (str or None) – Unique name for the site getting configured.

  • rx_bytes_on_local_subnet (long or None) – Bytes received on local network. 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.

  • secure_traffic (bool or None) – Enable/disable encription.

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

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

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

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

  • tunnel_status (str or None) –

    Possible values are:

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

  • tx_bytes_from_local_subnet (long or None) – Bytes transmitted from local subnet. 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.

TUNNEL_STATUS_CONNECTED = 'CONNECTED'
TUNNEL_STATUS_DISCONNECTED = 'DISCONNECTED'
TUNNEL_STATUS_UNKNOWN = 'UNKNOWN'
class com.vmware.vmc.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.vmc.model_client.Subnet(subnet_id=None, name=None, route_tables=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

(as there’s already one SubnetInfo, use Subnet instead)

Tip

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

Parameters

  • subnet_id (str or None) – subnet id

  • name (str or None) – subnet name

  • route_tables (list of SubnetRouteTableInfo or None) –

class com.vmware.vmc.model_client.SubnetInfo(compatible=None, connected_account_id=None, region_name=None, availability_zone=None, subnet_id=None, availability_zone_id=None, subnet_cidr_block=None, note=None, vpc_id=None, vpc_cidr_block=None, name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • compatible (bool or None) – Is this customer subnet compatible with the SDDC?

  • connected_account_id (str or None) – The ID of the connected account this subnet is from.

  • region_name (str or None) – The region this subnet is from.

  • availability_zone (str or None) – The availability zone (customer-centric) this subnet is in.

  • subnet_id (str or None) – The ID of the subnet.

  • availability_zone_id (str or None) – The availability zone id (customer-centric) this subnet is in.

  • subnet_cidr_block (str or None) – The CIDR block of the subnet.

  • note (str or None) – Why a subnet is marked as not compatible. May be blank if compatible.

  • vpc_id (str or None) – The ID of the VPC this subnet resides in.

  • vpc_cidr_block (str or None) – The CIDR block of the VPC containing this subnet.

  • name (str or None) – The name of the subnet. This is either the tagged name or the default AWS id it was given.

class com.vmware.vmc.model_client.SubnetRouteTableInfo(subnet_id=None, association_id=None, routetable_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • subnet_id (str or None) – subnet id

  • association_id (str or None) – subnet - route table association id

  • routetable_id (str or None) – route table id

class com.vmware.vmc.model_client.SubscriptionDetails(status=None, anniversary_billing_date=None, end_date=None, billing_frequency=None, auto_renewed_allowed=None, commitment_term=None, csp_subscription_id=None, billing_subscription_id=None, offer_version=None, offer_type=None, description=None, product_id=None, region=None, product_name=None, offer_name=None, commitment_term_uom=None, start_date=None, quantity=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

details of a subscription

Tip

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

Parameters
OFFER_TYPE_ON_DEMAND = 'ON_DEMAND'
OFFER_TYPE_TERM = 'TERM'
STATUS_ACTIVATED = 'ACTIVATED'
STATUS_CANCELLED = 'CANCELLED'
STATUS_CREATED = 'CREATED'
STATUS_EXPIRED = 'EXPIRED'
STATUS_FAILED = 'FAILED'
STATUS_ORDER_SUBMITTED = 'ORDER_SUBMITTED'
STATUS_PENDING_PROVISIONING = 'PENDING_PROVISIONING'
STATUS_SUSPENDED = 'SUSPENDED'
STATUS_TERMINATED = 'TERMINATED'
STATUS_UKNOWN = 'UKNOWN'
class com.vmware.vmc.model_client.SubscriptionProducts(product=None, types=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Details of products that are available for purchase.

Tip

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

Parameters

  • product (str or None) – The name of the product

  • types (list of str or None) – A list of different types/version for the product.

class com.vmware.vmc.model_client.SubscriptionRequest(product=None, product_type=None, product_id=None, billing_frequency=None, region=None, commitment_term=None, offer_context_id=None, offer_version=None, offer_name=None, quantity=None, type=None, price=None, product_charge_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • product (str or None) – The product for which subscription needs to be created. Refer /vmc/api/orgs/{orgId}/products.

  • product_type (str) – Old identifier for product. *Deprecarted*. See product and type

  • product_id (str or None) –

  • billing_frequency (str or None) – Frequency of the billing.

  • region (str) –

  • commitment_term (str) –

  • offer_context_id (str or None) –

  • offer_version (str) –

  • offer_name (str) –

  • quantity (long) –

  • type (str or None) – The type of the product for which the subscription needs to be created.

  • price (long or None) –

  • product_charge_id (str or None) –

class com.vmware.vmc.model_client.SupportWindow(start_day=None, seats=None, sddcs=None, duration_hours=None, start_hour=None, support_window_id=None, metadata=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
START_DAY_FRIDAY = 'FRIDAY'
START_DAY_MONDAY = 'MONDAY'
START_DAY_SATURDAY = 'SATURDAY'
START_DAY_SUNDAY = 'SUNDAY'
START_DAY_THURSDAY = 'THURSDAY'
START_DAY_TUESDAY = 'TUESDAY'
START_DAY_WEDNESDAY = 'WEDNESDAY'
class com.vmware.vmc.model_client.SupportWindowId(window_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

window_id (str or None) – Support Window ID

class com.vmware.vmc.model_client.Tag(key=None, value=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • key (str or None) –

  • value (str or None) –

class com.vmware.vmc.model_client.Task(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, status=None, localized_error_message=None, resource_id=None, parent_task_id=None, task_version=None, correlation_id=None, start_resource_entity_version=None, customer_error_message=None, sub_status=None, task_type=None, start_time=None, task_progress_phases=None, error_message=None, org_id=None, end_resource_entity_version=None, service_errors=None, org_type=None, estimated_remaining_minutes=None, params=None, progress_percent=None, phase_in_progress=None, resource_type=None, end_time=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • updated (datetime.datetime) –

  • user_id (str) – User id that last updated this record

  • updated_by_user_id (str) – User id that last updated this record

  • created (datetime.datetime) –

  • version (long) – Version of this entity format: int32

  • updated_by_user_name (str or None) – User name that last updated this record

  • user_name (str) – User name that last updated this record

  • id (str) – Unique ID for this entity

  • status (str or None) –

    Possible values are:

  • localized_error_message (str or None) –

  • resource_id (str or None) – UUID of the resource the task is acting upon

  • parent_task_id (str or None) – If this task was created by another task - this provides the linkage. Mostly for debugging.

  • task_version (str or None) –

  • correlation_id (str or None) – (Optional) Client provided uniqifier to make task creation idempotent. Be aware not all tasks support this. For tasks that do - supplying the same correlation Id, for the same task type, within a predefined window will ensure the operation happens at most once.

  • start_resource_entity_version (long or None) – Entity version of the resource at the start of the task. This is only set for some task types. format: int32

  • customer_error_message (str or None) –

  • sub_status (str or None) –

  • task_type (str or None) –

  • start_time (datetime.datetime or None) –

  • task_progress_phases (list of TaskProgressPhase or None) – Task progress phases involved in current task execution

  • error_message (str or None) –

  • org_id (str or None) –

  • end_resource_entity_version (long or None) – Entity version of the resource at the end of the task. This is only set for some task types. format: int32

  • service_errors (list of ServiceError or None) – Service errors returned from SDDC services.

  • org_type (str or None) –

  • estimated_remaining_minutes (long or None) – Estimated remaining time in minute of the task execution, < 0 means no estimation for the task. format: int32

  • params (vmware.vapi.struct.VapiStruct or None) –

  • progress_percent (long or None) – Estimated progress percentage the task executed format: int32

  • phase_in_progress (str or None) – The current in progress phase ID in the task execution, if none in progress, empty string returned.

  • resource_type (str or None) – Type of resource being acted upon

  • end_time (datetime.datetime or None) –

STATUS_CANCELED = 'CANCELED'
STATUS_CANCELING = 'CANCELING'
STATUS_FAILED = 'FAILED'
STATUS_FINISHED = 'FINISHED'
STATUS_STARTED = 'STARTED'
class com.vmware.vmc.model_client.TaskProgressPhase(id=None, name=None, progress_percent=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

A task progress can be (but does NOT have to be) divided to more meaningful progress phases.

Tip

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

Parameters

  • id (str) – The identifier of the task progress phase

  • name (str) – The display name of the task progress phase

  • progress_percent (long) – The percentage of the phase that has completed format: int32

class com.vmware.vmc.model_client.TenantServiceInfo(s3_log_bucket_arn=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

s3_log_bucket_arn (str or None) – S3 bucket arn used by log forwarder.

class com.vmware.vmc.model_client.TermBillingOptions(unit_price=None, billing_frequency=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Holder for term billing options.

Tip

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

Parameters

  • unit_price (str or None) –

  • billing_frequency (str or None) –

class com.vmware.vmc.model_client.TermOfferInstance(description=None, product=None, product_type=None, name=None, currency=None, region=None, commitment_term=None, unit_price=None, billing_options=None, version=None, offer_context_id=None, product_charge_id=None, type=None, product_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Holder for the term offer instances.

Tip

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

Parameters

  • description (str) –

  • product (str) –

  • product_type (str or None) – Deprecated. Please use product and type fields instead.

  • name (str) –

  • currency (str) –

  • region (str) –

  • commitment_term (long) –

  • unit_price (str) – (deprecated. unit_price is moved into TermBillingOptions. For backward compatibility, this field reflect “Prepaid” price at the offer level.)

  • billing_options (list of TermBillingOptions or None) –

  • version (str) –

  • offer_context_id (str or None) –

  • product_charge_id (str or None) –

  • type (str) –

  • product_id (str or None) –

class com.vmware.vmc.model_client.TermsOfServiceResult(terms_id=None, signed=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • terms_id (str or None) – The terms of service ID requested.

  • signed (bool or None) – Whether or not the terms requested have been signed.

class com.vmware.vmc.model_client.UpdateCredentials(username=None, password=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • username (str) – Username of the credentials

  • password (str) – Password associated with the credentials

class com.vmware.vmc.model_client.VmcLocale(locale=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

locale (str or None) – The locale to be used for translating responses for the session

class com.vmware.vmc.model_client.VpcInfo(esx_security_group_id=None, vpc_cidr=None, vgw_id=None, esx_public_security_group_id=None, vif_ids=None, vm_security_group_id=None, route_table_id=None, edge_subnet_id=None, id=None, api_association_id=None, api_subnet_id=None, private_subnet_id=None, private_association_id=None, vcdr_enis=None, subnet_id=None, internet_gateway_id=None, security_group_id=None, association_id=None, vgw_route_table_id=None, traffic_group_edge_vm_ips=None, edge_association_id=None, provider=None, tgw_ips=None, peering_connection_id=None, network_type=None, available_zones=None, routetables=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • esx_security_group_id (str or None) –

  • vpc_cidr (str or None) –

  • vgw_id (str or None) –

  • esx_public_security_group_id (str or None) –

  • vif_ids (list of str or None) – set of virtual interfaces attached to the sddc

  • vm_security_group_id (str or None) –

  • route_table_id (str or None) – (deprecated)

  • edge_subnet_id (str or None) – Id of the NSX edge associated with this VPC (deprecated)

  • id (str or None) – vpc id

  • api_association_id (str or None) – Id of the association between subnet and route-table (deprecated)

  • api_subnet_id (str or None) – Id associated with this VPC (deprecated)

  • private_subnet_id (str or None) – (deprecated)

  • private_association_id (str or None) – (deprecated)

  • vcdr_enis (list of EniInfo or None) – Set of VCDR (VMware Cloud Disaster Recovery) ENIs

  • subnet_id (str or None) – (deprecated)

  • internet_gateway_id (str or None) –

  • security_group_id (str or None) –

  • association_id (str or None) – (deprecated)

  • vgw_route_table_id (str or None) – Route table which contains the route to VGW (deprecated)

  • traffic_group_edge_vm_ips (list of str or None) – List of edge vm Ips of traffic gourps added during scale-out

  • edge_association_id (str or None) – Id of the association between edge subnet and route-table (deprecated)

  • provider (str or None) –

  • tgw_ips ((dict of str and list of str) or None) – Mapping from AZ to a list of IP addresses assigned to TGW ENI that’s connected with Vpc

  • peering_connection_id (str or None) – (deprecated)

  • network_type (str or None) –

  • available_zones (list of AvailableZoneInfo or None) –

  • routetables ((dict of str and RouteTableInfo) or None) – map from routeTableName to routeTableInfo

class com.vmware.vmc.model_client.VpcInfoSubnets(vpc_id=None, cidr_block=None, description=None, subnets=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • vpc_id (str or None) – The ID of the VPC these subnets belong to.

  • cidr_block (str or None) – The overall CIDR block of the VPC. This is the AWS primary CIDR block.

  • description (str or None) – The description of the VPC; usually it’s name or id.

  • subnets (list of SubnetInfo or None) –

class com.vmware.vmc.model_client.Vpn(version=None, on_prem_gateway_ip=None, on_prem_network_cidr=None, pfs_enabled=None, id=None, channel_status=None, on_prem_nat_ip=None, name=None, internal_network_ids=None, tunnel_statuses=None, encryption=None, enabled=None, state=None, dh_group=None, authentication=None, pre_shared_key=None, ike_option=None, digest_algorithm=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
AUTHENTICATION_PSK = 'PSK'
AUTHENTICATION_UNKNOWN = 'UNKNOWN'
DH_GROUP_DH14 = 'DH14'
DH_GROUP_DH15 = 'DH15'
DH_GROUP_DH16 = 'DH16'
DH_GROUP_DH2 = 'DH2'
DH_GROUP_DH5 = 'DH5'
DH_GROUP_UNKNOWN = 'UNKNOWN'
DIGEST_ALGORITHM_SHA1 = 'SHA1'
DIGEST_ALGORITHM_SHA_256 = 'SHA_256'
ENCRYPTION_AES = 'AES'
ENCRYPTION_AES256 = 'AES256'
ENCRYPTION_AES_GCM = 'AES_GCM'
ENCRYPTION_TRIPLE_DES = 'TRIPLE_DES'
ENCRYPTION_UNKNOWN = 'UNKNOWN'
IKE_OPTION_IKEV1 = 'IKEV1'
IKE_OPTION_IKEV2 = 'IKEV2'
STATE_CONNECTED = 'CONNECTED'
STATE_DISCONNECTED = 'DISCONNECTED'
STATE_PARTIALLY_CONNECTED = 'PARTIALLY_CONNECTED'
STATE_UNKNOWN = 'UNKNOWN'
class com.vmware.vmc.model_client.VpnChannelStatus(channel_status=None, channel_state=None, last_info_message=None, failure_message=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
CHANNEL_STATUS_CONNECTED = 'CONNECTED'
CHANNEL_STATUS_DISCONNECTED = 'DISCONNECTED'
CHANNEL_STATUS_UNKNOWN = 'UNKNOWN'
class com.vmware.vmc.model_client.VpnTunnelStatus(on_prem_subnet=None, traffic_stats=None, last_info_message=None, local_subnet=None, tunnel_state=None, failure_message=None, tunnel_status=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
TUNNEL_STATUS_CONNECTED = 'CONNECTED'
TUNNEL_STATUS_DISCONNECTED = 'DISCONNECTED'
TUNNEL_STATUS_UNKNOWN = 'UNKNOWN'
class com.vmware.vmc.model_client.VpnTunnelTrafficStats(packets_out=None, packet_received_errors=None, rx_bytes_on_local_subnet=None, replay_errors=None, sequence_number_over_flow_errors=None, encryption_failures=None, integrity_errors=None, packet_sent_errors=None, decryption_failures=None, packets_in=None, tx_bytes_from_local_subnet=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • packets_out (str or None) –

  • packet_received_errors (str or None) –

  • rx_bytes_on_local_subnet (str or None) –

  • replay_errors (str or None) –

  • sequence_number_over_flow_errors (str or None) –

  • encryption_failures (str or None) –

  • integrity_errors (str or None) –

  • packet_sent_errors (str or None) –

  • decryption_failures (str or None) –

  • packets_in (str or None) –

  • tx_bytes_from_local_subnet (str or None) –

class com.vmware.vmc.model_client.VsanAvailableCapacity(cost=None, quality=None, size=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Infomation about an available vSAN capacity in a cluster.

Tip

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

Parameters

  • cost (str) –

  • quality (str) –

  • size (long) –

class com.vmware.vmc.model_client.VsanClusterReconfigBias(short_description=None, full_description=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Bias for reconfiguring vSAN in a cluster.

Tip

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

Parameters

  • short_description (str) –

  • full_description (str) –

  • id (str) –

class com.vmware.vmc.model_client.VsanClusterReconfigConstraints(reconfig_biases=None, available_capacities=None, default_capacities=None, hosts=None, default_reconfig_bias_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Storage constraint information for reconfiguring vSAN in existing cluster.

Tip

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

Parameters

  • reconfig_biases (list of VsanClusterReconfigBias) – Biases to reconfigure vSAN in an existing cluster.

  • available_capacities (dict of str and list of VsanAvailableCapacity) – A map of VsanClusterReconfigBias id to the list of VsanAvailableCapacity. It gives all of available vSAN capacities for each of reconfiguration biases.

  • default_capacities (dict of str and VsanAvailableCapacity) – A map of VsanClusterReconfigBias id to a VsanAvailableCapacity. It gives the default VsanAvailableCapacity for each of reconfiguration biases.

  • hosts (long) – The number of hosts in a cluster for the constraints. format: int32

  • default_reconfig_bias_id (str) – The id of default VsanClusterReconfigBias for this constraints.

class com.vmware.vmc.model_client.VsanConfigConstraints(max_capacity=None, recommended_capacities=None, supported_capacity_increment=None, min_capacity=None, num_hosts=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

This describes the possible physical storage capacity choices for use with a given VsanStorageDesigner implementation. These choices are specific to a customer-defined number of hosts per cluster.

Tip

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

Parameters

  • max_capacity (long) – Maximum capacity supported for cluster (GiB). format: int64

  • recommended_capacities (list of long) – List of supported capacities which may offer preferable performance (GiB). format: int64

  • supported_capacity_increment (long or None) – Increment to be added to min_capacity to result in a supported capacity (GiB). format: int64

  • min_capacity (long) – Minimum capacity supported for cluster (GiB). format: int64

  • num_hosts (long) – Number of hosts in cluster. format: int64

class com.vmware.vmc.model_client.VsanEncryptionConfig(port=None, certificate=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

  • port (long or None) – Port to connect to AWS Key Management Service

  • certificate (str or None) – Public certificate used to connect to AWS Key Management Service

class com.vmware.vmc.model_client.WcpDetails(pod_cidr=None, egress_cidr=None, ingress_cidr=None, service_cidr=None, wcp_status=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters
WCP_STATUS_CERTIFICATE_REVOKE_FAILED = 'CERTIFICATE_REVOKE_FAILED'
WCP_STATUS_CERTIFICATE_REVOKE_IN_PROGRESS = 'CERTIFICATE_REVOKE_IN_PROGRESS'
WCP_STATUS_CERTIFICATE_UPDATE_FAILED = 'CERTIFICATE_UPDATE_FAILED'
WCP_STATUS_CERTIFICATE_UPDATE_IN_PROGRESS = 'CERTIFICATE_UPDATE_IN_PROGRESS'
WCP_STATUS_CERTIFICATE_UPDATE_PENDING = 'CERTIFICATE_UPDATE_PENDING'
WCP_STATUS_DISABLED = 'DISABLED'
WCP_STATUS_DISABLE_FAILED = 'DISABLE_FAILED'
WCP_STATUS_DISABLE_IN_PROGRESS = 'DISABLE_IN_PROGRESS'
WCP_STATUS_DISABLE_PENDING = 'DISABLE_PENDING'
WCP_STATUS_ENABLED = 'ENABLED'
WCP_STATUS_ENABLE_FAILED = 'ENABLE_FAILED'
WCP_STATUS_ENABLE_IN_PROGRESS = 'ENABLE_IN_PROGRESS'
WCP_STATUS_ENABLE_PENDING = 'ENABLE_PENDING'
class com.vmware.vmc.model_client.WitnessEsx(enum_state=None, name=None, mac_address=None, esx_id=None, hostname=None, provider='WitnessEsx')

Bases: vmware.vapi.bindings.struct.VapiStruct

Infomation about witness ESX host in a cluster.

Tip

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

Parameters
ENUM_STATE_DELETING = 'DELETING'
ENUM_STATE_DEPLOYING = 'DEPLOYING'
ENUM_STATE_FAILED = 'FAILED'
ENUM_STATE_PROVISIONED = 'PROVISIONED'
ENUM_STATE_READY = 'READY'
PROVIDER_AWS = 'AWS'
PROVIDER_ZEROCLOUD = 'ZEROCLOUD'
property provider

Return the discriminator value

class com.vmware.vmc.model_client.XEniInfo(association_id=None, trunk_eni_id=None, x_eni_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

This class represent a mapping between eniId created on customer account to the associationId and trunkEniId of ESX.

Tip

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

Parameters

  • association_id (str or None) – Field represent X-ENI associationId (On Shadow account).

  • trunk_eni_id (str or None) – Field represent one of the eniId of ESX host (used as trunkInterfaceId) during X-ENI association.

  • x_eni_id (str or None) – Field represent eniId which is created on customer account (X-ENI-ID).

com.vmware.vmc.orgs_client module

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(org)

Gets a link that can be used on a customer’s account to start the linking process.

Parameters

org (str) – Organization identifier (required)

Return type

com.vmware.vmc.model_client.LinkRequest

Returns

com.vmware.vmc.model.LinkRequest

Raise

com.vmware.vapi.std.errors_client.Error Generic Error

class com.vmware.vmc.orgs_client.PaymentMethods(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get_org_payment_methods(org, default_flag=None)

Get payment methods of organization

Parameters

  • org (str) – Organization identifier (required)

  • default_flag (bool or None) – When true, will only return default payment methods. (optional, default to false)

Return type

list of com.vmware.vmc.model_client.PaymentMethodInfo

Returns

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Organization doesn’t exist

class com.vmware.vmc.orgs_client.Providers(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

list(org)
Parameters

org (str) – Organization identifier (required)

Return type

list of com.vmware.vmc.model_client.AwsCloudProvider

Returns

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Organization doesn’t exist

class com.vmware.vmc.orgs_client.Reservations(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

list(org)

Get all reservations for this org

Deprecated since version unknown.

Parameters

org (str) – Organization identifier (required)

Return type

list of com.vmware.vmc.model_client.MaintenanceWindowEntry

Returns

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

com.vmware.vapi.std.errors_client.Unauthorized Access not allowed to the operation for the current user

class com.vmware.vmc.orgs_client.SddcTemplates(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(org, template_id)

Delete SDDC template identified by given id.

Parameters

  • org (str) – Organization identifier (required)

  • template_id (str) – SDDC Template identifier (required)

Return type

com.vmware.vmc.model_client.Task

Returns

com.vmware.vmc.model.Task

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

get(org, template_id)

Get configuration template by given template id.

Parameters

  • org (str) – Organization identifier (required)

  • template_id (str) – SDDC Template identifier (required)

Return type

com.vmware.vmc.model_client.SddcTemplate

Returns

com.vmware.vmc.model.SddcTemplate

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find the SDDC Template with given identifier

list(org)

List all available SDDC configuration templates in an organization

Parameters

org (str) – Organization identifier (required)

Return type

list of com.vmware.vmc.model_client.SddcTemplate

Returns

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

class com.vmware.vmc.orgs_client.Sddcs(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

create(org, sddc_config, validate_only=None)

Provision an SDDC in target cloud

Parameters

  • org (str) – Organization identifier (required)

  • sddc_config (com.vmware.vmc.model_client.AwsSddcConfig) – sddcConfig (required)

  • validate_only (bool or None) – When true, only validates the given sddc configuration without provisioning. (optional)

Return type

com.vmware.vmc.model_client.Task

Returns

com.vmware.vmc.model.Task

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

delete(org, sddc, retain_configuration=None, template_name=None, force=None)

Delete SDDC

Parameters

  • org (str) – Organization identifier (required)

  • sddc (str) – Sddc identifier (required)

  • retain_configuration (bool or None) – If = ‘true’, the SDDC’s configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state. (optional)

  • template_name (str or None) – Only applicable when retainConfiguration is also set to ‘true’. When set, this value will be used as the name of the SDDC configuration template generated. (optional)

  • force (bool or None) – If = true, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC. This option is restricted. (optional)

Return type

com.vmware.vmc.model_client.Task

Returns

com.vmware.vmc.model.Task

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

com.vmware.vapi.std.errors_client.InvalidRequest The sddc is not in a state that’s valid for deletion

Raise

com.vmware.vapi.std.errors_client.Unauthorized Access not allowed to the operation for the current user

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find the SDDC with given identifier

get(org, sddc)

Get SDDC

Parameters

  • org (str) – Organization identifier (required)

  • sddc (str) – Sddc identifier (required)

Return type

com.vmware.vmc.model_client.Sddc

Returns

com.vmware.vmc.model.Sddc

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find the SDDC with given identifier

list(org, include_deleted=None, filter=None)

List all the SDDCs of an organization

Parameters

  • org (str) – Organization identifier (required)

  • include_deleted (bool or None) – When true, forces the result to also include deleted SDDCs. (optional)

  • filter (str or None) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, ‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-’ (minus) String Operators: ‘startswith’, ‘endswith’, ‘length’, ‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed using ‘.’ Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal ‘created’ will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq ‘READY’) (optional)

Return type

list of com.vmware.vmc.model_client.Sddc

Returns

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

patch(org, sddc, sddc_patch_request)

Patch SDDC

Parameters
Return type

com.vmware.vmc.model_client.Sddc

Returns

com.vmware.vmc.model.Sddc

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

com.vmware.vapi.std.errors_client.InvalidRequest SDDC cannot be patched

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find the SDDC with given identifier

class com.vmware.vmc.orgs_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.vmc.orgs_client.Subscriptions(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

GET_0_OFFER_TYPE_ON_DEMAND = 'ON_DEMAND'

Possible value for offerType of method Subscriptions.get_0().

GET_0_OFFER_TYPE_TERM = 'TERM'

Possible value for offerType of method Subscriptions.get_0().

create(org, subscription_request)

Initiates the creation of a subscription

Parameters
Return type

com.vmware.vmc.model_client.Task

Returns

com.vmware.vmc.model.Task

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

Raise

com.vmware.vapi.std.errors_client.InternalServerError Server error. Check retryable flag to see if request should be retried.

get(org, subscription)

Get subscription details for a given subscription id

Parameters

  • org (str) – Organization identifier (required)

  • subscription (str) – SubscriptionId for an sddc. (required)

Return type

com.vmware.vmc.model_client.SubscriptionDetails

Returns

com.vmware.vmc.model.SubscriptionDetails

Raise

com.vmware.vapi.std.errors_client.InternalServerError Server error. Check retryable flag to see if request should be retried.

Raise

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

get_0(org, offer_type=None)

Returns default billing account subscriptions for a given org id

Parameters

  • org (str) – Organization identifier (required)

  • offer_type (str or None) – Offer Type * \`ON_DEMAND\` - on-demand subscription * \`TERM\` - term subscription * All subscriptions if not specified (optional)

Return type

list of com.vmware.vmc.model_client.SubscriptionDetails

Returns

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

com.vmware.vapi.std.errors_client.InternalServerError Server error. Check retryable flag to see if request should be retried.

Raise

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

class com.vmware.vmc.orgs_client.Tasks(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(org, task)

Retrieve details of a task.

Parameters

  • org (str) – Organization identifier (required)

  • task (str) – Task identifier (required)

Return type

com.vmware.vmc.model_client.Task

Returns

com.vmware.vmc.model.Task

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find the task with given identifier

list(org, filter=None)

List all tasks with optional filtering.

Parameters

  • org (str) – Organization identifier (required)

  • filter (str or None) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, ‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-’ (minus) String Operators: ‘startswith’, ‘endswith’, ‘length’, ‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed using ‘.’ Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal ‘created’ will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq ‘READY’) (optional)

Return type

list of com.vmware.vmc.model_client.Task

Returns

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

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

update(org, task, action=None)

Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status.

Parameters

  • org (str) – Organization identifier (required)

  • task (str) – Task identifier (required)

  • action (str or None) – If = ‘cancel’, task will be canceled (optional)

Return type

com.vmware.vmc.model_client.Task

Returns

com.vmware.vmc.model.Task

Raise

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid action or bad argument

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find the task with given identifier

class com.vmware.vmc.orgs_client.Tos(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(org, terms_id)

Queries for the terms of service of a given org.

Parameters

  • org (str) – Organization identifier (required)

  • terms_id (str) – The terms of service reference ID to check on. (required)

Return type

com.vmware.vmc.model_client.TermsOfServiceResult

Returns

com.vmware.vmc.model.TermsOfServiceResult

Raise

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