com.vmware.vmc package

Subpackages

Submodules

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.AddressFWSourceDestination(exclude=None, ip_address=None, grouping_object_id=None, vnic_group_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Source or Destination for firewall rule. Default is ‘any’.

Tip

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

Parameters:
  • exclude (bool or None) – Exclude the specified source or destination.
  • ip_address (list of str or None) – List of string. Can specify single IP address, range of IP address, or in CIDR format. Can define multiple.
  • grouping_object_id (list of str or None) – List of string. Id of cluster, datacenter, distributedPortGroup, legacyPortGroup, VirtualMachine, vApp, resourcePool, logicalSwitch, IPSet, securityGroup. Can define multiple.
  • vnic_group_id (list of str or None) – List of string. Possible values are vnic-index-[1-9], vse, external or internal. Can define multiple.
class com.vmware.vmc.model_client.Agent(addresses=None, healthy=None, custom_properties=None, last_health_status_change=None, internal_ip=None, reserved_ip=None, network_netmask=None, network_gateway=None, provider='Agent', agent_url=None, network_cidr=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • addresses (list of str or None) –
  • healthy (bool or None) –
  • custom_properties ((dict of str and str) or None) –
  • last_health_status_change (long or None) –
  • internal_ip (str or None) –
  • reserved_ip (str or None) –
  • network_netmask (str or None) –
  • network_gateway (str or None) –
  • provider (str) –
  • agent_url (str or None) –
  • network_cidr (str or None) –
  • id (str or None) –
class com.vmware.vmc.model_client.AmiInfo(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:
  • 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.AppliancesSummary(data_store_moid_of_active_vse=None, enable_fips=None, host_name_of_active_vse=None, vm_build_info=None, deploy_appliances=None, communication_channel=None, vm_name_of_active_vse=None, number_of_deployed_vms=None, resource_pool_moid_of_active_vse=None, data_store_name_of_active_vse=None, vm_moid_of_active_vse=None, status_from_vse_updated_on=None, fqdn=None, appliance_size=None, resource_pool_name_of_active_vse=None, active_vse_ha_index=None, vm_version=None, host_moid_of_active_vse=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NSX Edge appliance summary.

Tip

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

Parameters:
  • data_store_moid_of_active_vse (str or None) – vCenter MOID of the active NSX Edge appliance’s data store.
  • enable_fips (bool or None) – Value is true if FIPS is enabled on NSX Edge appliance.
  • host_name_of_active_vse (str or None) – Host name of the active NSX Edge appliance.
  • vm_build_info (str or None) – NSX Edge appliance build version.
  • deploy_appliances (bool or None) – Value is true if NSX Edge appliances are to be deployed.
  • communication_channel (str or None) – Communication channel used to communicate with NSX Edge appliance.
  • vm_name_of_active_vse (str or None) – Name of the active NSX Edge appliance.
  • number_of_deployed_vms (long or None) – Number of deployed appliances of the NSX Edge. format: int32
  • resource_pool_moid_of_active_vse (str or None) – vCenter MOID of the active NSX Edge appliance’s resource pool/cluster. Can be resource pool ID, e.g. resgroup-15 or cluster ID, e.g. domain-c41.
  • data_store_name_of_active_vse (str or None) – Datastore name of the active NSX Edge appliance.
  • vm_moid_of_active_vse (str or None) – vCenter MOID of the active NSX Edge appliance.
  • status_from_vse_updated_on (long or None) – Time stamp value when healthcheck status was last updated for the NSX Edge appliance. format: int64
  • fqdn (str or None) – FQDN of the NSX Edge.
  • appliance_size (str or None) – NSX Edge appliance size.
  • resource_pool_name_of_active_vse (str or None) – Resource Pool/Cluster name of the active NSX Edge appliance.
  • active_vse_ha_index (long or None) – HA index of the active NSX Edge appliance. format: int32
  • vm_version (str or None) – NSX Edge appliance version.
  • host_moid_of_active_vse (str or None) – vCenter MOID of the active NSX Edge appliance’s host.
class com.vmware.vmc.model_client.Application(application_id=None, service=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Application for firewall rule

Tip

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

Parameters:
  • application_id (list of str or None) – List of string. Id of service or serviceGroup groupingObject. Can define multiple.
  • service (list of Nsxfirewallservice or None) – List of protocol and ports. Can define multiple.
class com.vmware.vmc.model_client.AwsAgent(instance_id=None, key_pair=None, addresses=None, healthy=None, custom_properties=None, last_health_status_change=None, internal_ip=None, reserved_ip=None, network_netmask=None, network_gateway=None, provider='AWS', agent_url=None, network_cidr=None, id=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) –
  • key_pair (AwsKeyPair or None) –
  • addresses (list of str or None) –
  • healthy (bool or None) –
  • custom_properties ((dict of str and str) or None) –
  • last_health_status_change (long or None) –
  • internal_ip (str or None) –
  • reserved_ip (str or None) –
  • network_netmask (str or None) –
  • network_gateway (str or None) –
  • provider (str) –
  • agent_url (str or None) –
  • network_cidr (str or None) –
  • id (str or None) –
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
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 (vmware.vapi.struct.VapiStruct 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, account_number=None, policy_external_id=None, region_to_az_to_shadow_mapping=None, org_id=None, cf_stack_name=None, policy_service_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) –
  • account_number (str or None) –
  • policy_external_id (str or None) –
  • region_to_az_to_shadow_mapping (vmware.vapi.struct.VapiStruct 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) –
  • policy_service_arn (str or None) –
class com.vmware.vmc.model_client.AwsEsxHost(internal_public_ip_pool=None, name=None, availability_zone=None, esx_id=None, hostname=None, provider='AWS', mac_address=None, custom_properties=None, esx_state=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.AwsKeyPair(key_name=None, key_fingerprint=None, key_material=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) –
class com.vmware.vmc.model_client.AwsOrgConfiguration(provider='AWS')

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:provider (str) –

Possible values are:

Discriminator for provider specific properties
class com.vmware.vmc.model_client.AwsSddcConfig(region=None, vpc_name=None, name=None, account_link_sddc_config=None, vpc_cidr=None, num_hosts=None, sddc_type=None, vxlan_subnet=None, account_link_config=None, provider='AWS', sso_domain=None, sddc_template_id=None, deployment_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • region (str) –
  • vpc_name (str or None) –
  • name (str) –
  • account_link_sddc_config (list of AccountLinkSddcConfig or None) – A list of the SDDC linking configurations to use.
  • vpc_cidr (str or None) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.
  • num_hosts (long) –
  • sddc_type (str or None) – Denotes the sddc type , if the value is null or empty, the type is considered as default.
  • vxlan_subnet (str or None) – VXLAN IP subnet
  • account_link_config (AccountLinkConfig or None) – The account linking configuration, we will keep this one and remove accountLinkSddcConfig finally.
  • 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.
  • sddc_template_id (str or None) – If provided, configuration from the template will applied to the provisioned SDDC. format: UUID
  • deployment_type (str or None) –

    Possible values are:

    Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is SingleAZ.
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, org_id=None, sddc_id=None, cidr_block_vpc=None, subnet_availability_zone=None, vpc_id=None, is_cgw_present=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) –
  • connected_account_id (str or None) –
  • eni_group (str or None) –
  • subnet_id (str or None) –
  • org_id (str or None) –
  • sddc_id (str or None) –
  • cidr_block_vpc (str or None) –
  • subnet_availability_zone (str or None) –
  • vpc_id (str or None) –
  • is_cgw_present (bool or None) –
  • customer_eni_infos (list of str or None) –
  • default_route_table (str or None) –
class com.vmware.vmc.model_client.AwsSddcResourceConfig(account_link_sddc_config=None, public_ip_pool=None, region=None, vpc_info=None, max_num_public_ip=None, vpc_info_peered_agent=None, backup_restore_bucket=None, nsxt=None, mgw_id=None, nsx_mgr_url=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, management_ds=None, custom_properties=None, cloud_password=None, provider='AWS', clusters=None, vc_management_ip=None, sddc_networks=None, cloud_username=None, esx_hosts=None, nsx_mgr_management_ip=None, vc_instance_id=None, esx_cluster_id=None, vc_public_ip=None, vc_url=None, sddc_manifest=None, vxlan_subnet=None, cloud_user_group=None, management_rp=None, witness_availability_zone=None, sso_domain=None, deployment_type=None, dns_with_management_vm_private_ip=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • account_link_sddc_config (list of SddcLinkConfig or None) –
  • public_ip_pool (list of SddcPublicIp or None) –
  • region (str or None) –
  • vpc_info (VpcInfo or None) –
  • max_num_public_ip (long or None) – maximum number of public IP that user can allocate.
  • vpc_info_peered_agent (VpcInfo or None) –
  • backup_restore_bucket (str or None) –
  • nsxt (bool or None) – if true, NSX-T UI is enabled.
  • mgw_id (str or None) – Management Gateway Id
  • nsx_mgr_url (str or None) – URL of the NSX Manager
  • 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.
  • management_ds (str or None) – The ManagedObjectReference of the management Datastore
  • custom_properties ((dict of str and str) or None) –
  • cloud_password (str or None) – Password for vCenter SDDC administrator
  • provider (str) –

    Possible values are:

    Discriminator for additional properties
  • clusters (list of vmware.vapi.struct.VapiStruct or None) – List of clusters in the SDDC. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in Cluster. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in Cluster.
  • vc_management_ip (str or None) – vCenter internal management IP
  • sddc_networks (list of str or None) –
  • cloud_username (str or None) – Username for vCenter SDDC administrator
  • esx_hosts (list of AwsEsxHost or None) –
  • nsx_mgr_management_ip (str or None) – NSX Manager internal management IP
  • vc_instance_id (str or None) – unique id of the vCenter server
  • esx_cluster_id (str or None) – Cluster Id to add ESX workflow
  • vc_public_ip (str or None) – vCenter public IP
  • vc_url (str or None) – URL of the vCenter server
  • sddc_manifest (SddcManifest or None) –
  • vxlan_subnet (str or None) – VXLAN IP subnet
  • 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.
  • sso_domain (str or None) – The SSO domain name to use for vSphere users
  • deployment_type (str or None) –

    Possible values are:

    Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.
  • dns_with_management_vm_private_ip (bool or None) – if true, use the private IP addresses to register DNS records for the management VMs
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.CaCertificates(ca_certificate=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

CA certificate list. Optional.

Tip

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

Parameters:ca_certificate (list of str or None) –
class com.vmware.vmc.model_client.CbmStatistic(vnic=None, timestamp=None, out=None, in_=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Statistics data for each vnic.

Tip

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

Parameters:
  • vnic (long or None) – Vnic index. format: int32
  • timestamp (long or None) – Timestamp value. format: int64
  • out (float or None) – Tx rate (Kilobits per second - kbps) format: double
  • in (float or None) – Rx rate (Kilobits per second - kbps) format: double
class com.vmware.vmc.model_client.CbmStatistics(data_dto=None, meta_dto=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NSX Edge Interface Statistics.

Tip

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

Parameters:
class com.vmware.vmc.model_client.CbmStatsData(vnic9=None, vnic8=None, vnic7=None, vnic6=None, vnic5=None, vnic4=None, vnic3=None, vnic2=None, vnic1=None, vnic0=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Statistics data.

Tip

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

Parameters:
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
class com.vmware.vmc.model_client.Cluster(cluster_name=None, esx_host_list=None, cluster_id='Cluster', cluster_state=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
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(num_hosts=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:num_hosts (long) –
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.CrlCertificates(crl_certificate=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

CRL certificate list. Optional.

Tip

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

Parameters:crl_certificate (list of str or None) –
class com.vmware.vmc.model_client.DashboardData(firewall=None, sslvpn=None, interfaces=None, load_balancer=None, ipsec=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Dashboard Statistics data.

Tip

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

Parameters:
class com.vmware.vmc.model_client.DashboardStat(timestamp=None, value=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • timestamp (long or None) –
  • value (float or None) –
class com.vmware.vmc.model_client.DashboardStatistics(data_dto=None, meta_dto=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Dashboard Statistics data.

Tip

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

Parameters:
class com.vmware.vmc.model_client.DataPageEdgeSummary(paging_info=None, data=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.DataPageSddcNetwork(paging_info=None, data=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.DataPermissions(save_permission=None, publish_permission=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • save_permission (bool or None) –
  • publish_permission (bool or None) –
class com.vmware.vmc.model_client.DhcpLeaseInfo(host_lease_info_dtos=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DHCP lease information.

Tip

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

Parameters:host_lease_info_dtos (list of HostLeaseInfo or None) – List of DHCP leases.
class com.vmware.vmc.model_client.DhcpLeases(time_stamp=None, host_lease_infos_dto=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DHCP leases information

Tip

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

Parameters:
  • time_stamp (long or None) – The timestamp of the DHCP lease. format: int64
  • host_lease_infos_dto (DhcpLeaseInfo or None) – DHCP lease information.
class com.vmware.vmc.model_client.DnsConfig(feature_type=None, logging=None, enabled=None, dns_views=None, listeners=None, version=None, template=None, cache_size=None, dns_servers=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DNS configuration

Tip

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

Parameters:
  • feature_type (str or None) –
  • logging (Logging or None) – DNS logging setting.
  • enabled (bool or None) – Value is true if feature is enabled. Default value is true. Optional.
  • dns_views (DnsViews or None) – List of DNS views.
  • listeners (DnsListeners or None) – List of DNS listeners.
  • version (long or None) – Version number tracking each configuration change. To avoid problems with overwriting changes, always retrieve and modify the latest configuration to include the current version number in your request. If you provide a version number which is not current, the request is rejected. If you omit the version number, the request is accepted but may overwrite any current changes if your change is not in sync with the latest change. format: int64
  • template (str or None) –
  • cache_size (long or None) – The cache size of the DNS service. format: int64
  • dns_servers (IpAddresses or None) –
class com.vmware.vmc.model_client.DnsForwarders(ip_address=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DNS forwarders.

Tip

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

Parameters:ip_address (list of str or None) – IP addresses of the DNS servers.
class com.vmware.vmc.model_client.DnsListeners(ip_address=None, vnic=None, type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • ip_address (list of str or None) – List of IP addresses.
  • vnic (list of str or None) – Vnic for DNS listener.
  • type (str or None) –
class com.vmware.vmc.model_client.DnsResponseStats(total=None, form_err=None, nx_domain=None, success=None, server_fail=None, nxrrset=None, others=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DNS response statistics.

Tip

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

Parameters:
  • total (long or None) –
  • form_err (long or None) –
  • nx_domain (long or None) –
  • success (long or None) –
  • server_fail (long or None) –
  • nxrrset (long or None) –
  • others (long or None) –
class com.vmware.vmc.model_client.DnsStatusAndStats(time_stamp=None, requests=None, responses=None, cached_dbrr_set=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DNS statistics.

Tip

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

Parameters:
  • time_stamp (long or None) –
  • requests (Requests or None) –
  • responses (DnsResponseStats or None) –
  • cached_dbrr_set (long or None) –
class com.vmware.vmc.model_client.DnsView(name=None, view_match=None, recursion=None, view_id=None, forwarders=None, enabled=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DNS View

Tip

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

Parameters:
  • name (str) – Name of the DNS view.
  • view_match (DnsViewMatch or None) – Rules that match the DNS query to this view. The rule can be ipAddress, or ipSet. Defaults to ipAddress ‘any’ and ‘any’ vnic.
  • recursion (bool or None) – Recursion enabled on DNS view.
  • view_id (str or None) – Identifier for the DNS view.
  • forwarders (DnsForwarders or None) – DNS forwarders.
  • enabled (bool or None) – DNS view is enabled.
class com.vmware.vmc.model_client.DnsViewMatch(vnic=None, ip_set=None, ip_address=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Dns view match

Tip

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

Parameters:
  • vnic (list of str or None) –
  • ip_set (list of str or None) –
  • ip_address (list of str or None) –
class com.vmware.vmc.model_client.DnsViews(dns_view=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DNS views.

Tip

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

Parameters:dns_view (list of DnsView or None) – List of DNS views.
class com.vmware.vmc.model_client.EdgeJob(status=None, edge_id=None, module=None, job_id=None, error_code=None, result=None, start_time=None, message=None, end_time=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Job status information for the configuration change carried out on NSX Edge.

Tip

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

Parameters:
  • status (str or None) – Job status.
  • edge_id (str or None) – NSX Edge ID.
  • module (str or None) – Module information.
  • job_id (str or None) – Job ID.
  • error_code (str or None) – Error code identifying the failure of the configuration change.
  • result (list of Result or None) – Job result information.
  • start_time (datetime.datetime or None) – Job start time. format: date-time
  • message (str or None) – Job message.
  • end_time (datetime.datetime or None) – Job end time. format: date-time
class com.vmware.vmc.model_client.EdgeStatus(pre_rules_exists=None, feature_statuses=None, timestamp=None, publish_status=None, last_published_pre_rules_generation_number=None, version=None, edge_vm_status=None, active_vse_ha_index=None, system_status=None, ha_vnic_in_use=None, edge_status=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NSX Edge Appliance status.

Tip

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

Parameters:
  • pre_rules_exists (bool or None) – Value is true if pre rules publish is enabled.
  • feature_statuses (list of FeatureStatus or None) – Individual feature status.
  • timestamp (long or None) – Timestamp value at which the NSX Edge healthcheck was done. format: int64
  • publish_status (str or None) – Status of the latest configuration change for the NSX Edge. Values are APPLIED or PERSISTED (not published to NSX Edge Appliance yet).
  • last_published_pre_rules_generation_number (long or None) – Value of the last published pre rules generation number. format: int64
  • version (long or None) – Version number of the current configuration. format: int64
  • edge_vm_status (list of EdgeVmStatus or None) – Detailed status of each of the deployed NSX Edge appliances.
  • active_vse_ha_index (long or None) – Index of the active NSX Edge appliance. Values are 0 and 1. format: int32
  • system_status (str or None) – System status of the active NSX Edge appliance.
  • ha_vnic_in_use (long or None) – Index of the vnic consumed for NSX Edge HA. format: int32
  • edge_status (str or None) – NSX Edge appliance health status identified by GREY (unknown status), GREEN (health checks are successful), YELLOW (intermittent health check failure), RED (none of the appliances are in serving state). If health check fails for 5 consecutive times for all appliance (2 for HA else 1) then status will turn from YELLOW to RED.
class com.vmware.vmc.model_client.EdgeSummary(feature_capabilities=None, edge_type=None, logical_router_scopes=None, recent_job_info=None, hypervisor_assist=None, edge_assist_id=None, edge_status=None, edge_assist_instance_name=None, object_id=None, node_id=None, id=None, datacenter_name=None, state=None, client_handle=None, scope=None, type=None, revision=None, vsm_uuid=None, description=None, extended_attributes=None, local_egress_enabled=None, universal_revision=None, allowed_actions=None, object_type_name=None, is_upgrade_available=None, is_universal=None, name=None, lrouter_uuid=None, appliances_summary=None, api_version=None, tenant_id=None, datacenter_moid=None, number_of_connected_vnics=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NSX Edge summary. Read only.

Tip

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

Parameters:
  • feature_capabilities (FeatureCapabilities or None) – List of Features and their capability details based on Edge appliance form factor.
  • edge_type (str or None) – NSX Edge type, whether ‘gatewayServices’ or ‘distributedRouter’.
  • logical_router_scopes (LogicalRouterScopes or None) – Backing type scope (DistributedVirtualSwitch - VLAN, TransportZone -VXLAN) and its ID for the Distributed Logical Router.
  • recent_job_info (EdgeJob or None) – Job information for the most recent configuration change carried out on the NSX Edge.
  • hypervisor_assist (bool or None) –
  • edge_assist_id (long or None) – ID generated by NSX Manager for Distributed Logical Router only. format: int64
  • edge_status (str or None) – NSX Edge appliance health status identified by GREY (unknown status), GREEN (health checks are successful), YELLOW (intermittent health check failure), RED (none of the appliances are in serving state). If health check fails for 5 consecutive times for all appliance (2 for HA else 1) then status will turn from YELLOW to RED.
  • edge_assist_instance_name (str or None) – Name derived by NSX Manager only for Distributed Logical Router.
  • object_id (str or None) –
  • node_id (str or None) –
  • id (str or None) – NSX Edge ID.
  • datacenter_name (str or None) – Datacenter name where the NSX Edge is deployed.
  • state (str or None) – Deployment state of the NSX Edge appliance. Values are ‘deployed’ when VMs have been deployed, ‘undeployed’ when no VMs are deployed and ‘active’ when Edge type is Distributed Logical Router and has no appliance deployed but is serving data path.
  • client_handle (str or None) –
  • scope (ScopeInfo or None) –
  • type (ObjectType or None) –
  • revision (long or None) –
  • vsm_uuid (str or None) –
  • description (str or None) –
  • extended_attributes (list of ExtendedAttribute or None) –
  • local_egress_enabled (bool or None) – Value is true if local egress is enabled for UDLR traffic. Applicable only for Universal Distributed Logical Router.
  • universal_revision (long or None) –
  • allowed_actions (list of str or None) –
  • object_type_name (str or None) –
  • is_upgrade_available (bool or None) – Value is true if NSX Edge upgrade is available.
  • is_universal (bool or None) –
  • name (str or None) –
  • lrouter_uuid (str or None) – Distributed Logical Router UUID provided by the NSX Controller.
  • appliances_summary (AppliancesSummary or None) – NSX Edge appliance summary.
  • api_version (str or None) – REST API version applicable for the NSX Edge.
  • tenant_id (str or None) – Tenant ID for the NSX Edge.
  • datacenter_moid (str or None) – vCenter MOID of the datacenter where the NSX Edge is deployed.
  • number_of_connected_vnics (long or None) – Number of connected vnics that are configured on the NSX Edge. format: int32
class com.vmware.vmc.model_client.EdgeVmStatus(index=None, ha_state=None, name=None, id=None, edge_vm_status=None, pre_rules_generation_number=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Status of each of the deployed NSX Edge appliances.

Tip

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

Parameters:
  • index (long or None) – High Availability index of the appliance. Values are 0 and 1. format: int32
  • ha_state (str or None) – High Availability state of the appliance. Values are active and standby.
  • name (str or None) – Name of the NSX Edge appliance.
  • id (str or None) – vCenter MOID of the NSX Edge appliance.
  • edge_vm_status (str or None) – NSX Edge appliance health status identified by GREY (unknown status), GREEN (health checks are successful), YELLOW (intermittent health check failure), RED (appliance not in serving state).
  • pre_rules_generation_number (long or None) – Value of the last published pre rules generation number. format: int64
class com.vmware.vmc.model_client.EdgeVnicAddressGroup(subnet_prefix_length=None, secondary_addresses=None, primary_address=None, subnet_mask=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Address group configuration of the NSX Edge vnic. An interface can have one primary and multiple secondary IP addresses.

Tip

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

Parameters:
  • subnet_prefix_length (str or None) – Subnet prefix length of the primary IP address.
  • secondary_addresses (SecondaryAddresses or None) – Secondary IP addresses of the NSX Edge vnic address group. Optional.
  • primary_address (str or None) – Primary IP address of the vnic interface. Required.
  • subnet_mask (str or None) –
class com.vmware.vmc.model_client.EdgeVnicAddressGroups(address_groups=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NSX Edge vnic address group configuration details.

Tip

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

Parameters:address_groups (list of EdgeVnicAddressGroup or None) – Address group configuration of the NSX Edge vnic. Vnic can be configured to have more than one address group/subnets.
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(num_hosts=None, availability_zone=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • num_hosts (long) –
  • availability_zone (str or None) – Availability zone where the hosts should be provisioned. (Can be specified only for privileged host operations).
class com.vmware.vmc.model_client.EsxHost(name=None, availability_zone=None, esx_id=None, hostname=None, provider='EsxHost', mac_address=None, custom_properties=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_DELETED = 'DELETED'
ESX_STATE_DELETING = 'DELETING'
ESX_STATE_DEPLOYING = 'DEPLOYING'
ESX_STATE_FAILED = 'FAILED'
ESX_STATE_PROVISIONED = 'PROVISIONED'
ESX_STATE_READY = 'READY'
class com.vmware.vmc.model_client.ExtendedAttribute(name=None, value=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) –
  • value (str or None) –
class com.vmware.vmc.model_client.FeatureCapabilities(timestamp=None, feature_capabilities=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

List of features and their capability details based on NSX Edge appliance form factor.

Tip

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

Parameters:
  • timestamp (long or None) – Time stamp value at which the feature capabilities were retrieved. format: int64
  • feature_capabilities (list of FeatureCapability or None) – List of feature capability information.
class com.vmware.vmc.model_client.FeatureCapability(configuration_limits=None, is_supported=None, service=None, permission=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Feature capability information.

Tip

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

Parameters:
  • configuration_limits (list of KeyValueAttributes or None) – List of key value pairs describing the feature configuration limits.
  • is_supported (bool or None) – Value is true if feature is supported on NSX Edge.
  • service (str or None) – Name of the feature or service.
  • permission (LicenceAclPermissions or None) – Licence and access control information for the feature.
class com.vmware.vmc.model_client.FeatureStatus(status=None, configured=None, server_status=None, publish_status=None, service=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Individual feature status.

Tip

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

Parameters:
  • status (str or None) – Status of the feature or service.
  • configured (bool or None) – Value is true if feature is configured.
  • server_status (str or None) – Server status of the feature or service. Values are up and down.
  • publish_status (str or None) – Publish status of the feature, whether APPLIED or PERSISTED.
  • service (str or None) – Name of the feature or service.
class com.vmware.vmc.model_client.FirewallConfig(firewall_rules=None, feature_type=None, version=None, template=None, global_config=None, enabled=None, default_policy=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Firewall Configuration

Tip

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

Parameters:
  • firewall_rules (FirewallRules or None) – Ordered list of firewall rules.
  • feature_type (str or None) –
  • version (long or None) – Version number tracking each configuration change. To avoid problems with overwriting changes, always retrieve and modify the latest configuration to include the current version number in your request. If you provide a version number which is not current, the request is rejected. If you omit the version number, the request is accepted but may overwrite any current changes if your change is not in sync with the latest change. format: int64
  • template (str or None) –
  • global_config (FirewallGlobalConfig or None) – Global configuration applicable to all rules.
  • enabled (bool or None) – Value is true if feature is enabled. Default value is true. Optional.
  • default_policy (FirewallDefaultPolicy or None) – Default Policy.
class com.vmware.vmc.model_client.FirewallDashboardStats(connections=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Dashboard Statistics data for Firewall.

Tip

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

Parameters:connections (list of DashboardStat or None) – Number of NSX Edge firewall connections and rules.
class com.vmware.vmc.model_client.FirewallDefaultPolicy(action=None, logging_enabled=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Firewall default policy. Default is deny.

Tip

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

Parameters:
  • action (str or None) – Action. Default is deny. Supported values accept, deny
  • logging_enabled (bool or None) – Enable logging for the rule.
class com.vmware.vmc.model_client.FirewallGlobalConfig(tcp_allow_out_of_window_packets=None, udp_timeout=None, ip_generic_timeout=None, tcp_pick_ongoing_connections=None, tcp_timeout_open=None, tcp_timeout_close=None, icmp6_timeout=None, drop_icmp_replays=None, log_icmp_errors=None, tcp_send_reset_for_closed_vse_ports=None, drop_invalid_traffic=None, enable_syn_flood_protection=None, icmp_timeout=None, tcp_timeout_established=None, log_invalid_traffic=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Global configuration applicable to all rules.

Tip

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

Parameters:
  • tcp_allow_out_of_window_packets (bool or None) – Allow TCP out of window packets.
  • udp_timeout (long or None) – UDP timeout close. format: int32
  • ip_generic_timeout (long or None) – IP generic timeout. format: int32
  • tcp_pick_ongoing_connections (bool or None) – Pick TCP ongoing connections.
  • tcp_timeout_open (long or None) – TCP timeout open. format: int32
  • tcp_timeout_close (long or None) – TCP timeout close. format: int32
  • icmp6_timeout (long or None) – ICMP6 timeout. format: int32
  • drop_icmp_replays (bool or None) – Drop icmp replays.
  • log_icmp_errors (bool or None) – Log icmp errors.
  • tcp_send_reset_for_closed_vse_ports (bool or None) – Send TCP reset for closed NSX Edge ports.
  • drop_invalid_traffic (bool or None) – Drop invalid traffic.
  • enable_syn_flood_protection (bool or None) – Protect against SYN flood attacks by detecting bogus TCP connections and terminating them without consuming firewall state tracking resources. Default : false
  • icmp_timeout (long or None) – ICMP timeout. format: int32
  • tcp_timeout_established (long or None) – TCP timeout established. format: int32
  • log_invalid_traffic (bool or None) – Log invalid traffic.
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.FirewallRuleStats(timestamp=None, connection_count=None, byte_count=None, packet_count=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Statistics for firewall rule

Tip

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

Parameters:
  • timestamp (long or None) – Timestamp of statistics collection. format: int64
  • connection_count (long or None) – Connection count. format: int64
  • byte_count (long or None) – Byte count. format: int64
  • packet_count (long or None) – Packet count. format: int64
class com.vmware.vmc.model_client.FirewallRules(firewall_rules=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Ordered list of firewall rules.

Tip

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

Parameters:firewall_rules (list of Nsxfirewallrule or None) – Ordered list of firewall rules.
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.HostLeaseInfo(mac_address=None, ends=None, abandoned=None, cltt=None, client_hostname=None, starts=None, binding_state=None, hardware_type=None, tsfp=None, uid=None, next_binding_state=None, ip_address=None, tstp=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DHCP lease information.

Tip

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

Parameters:
  • mac_address (str or None) – MAC address of the client.
  • ends (str or None) – End time of the lease.
  • abandoned (str or None) – Time stamp of when IP address was marked as abandoned.
  • cltt (str or None) – Client Last Transaction Time of the lease info.
  • client_hostname (str or None) – Name of the client.
  • starts (str or None) – Start time of the lease.
  • binding_state (str or None) – Lease’s binding state.
  • hardware_type (str or None) – The hardware type on which the lease will be used.
  • tsfp (str or None) – Time Sent From Partner of the lease info.
  • uid (str or None) – Uid to identify the DHCP lease.
  • next_binding_state (str or None) – Indicates what state the lease will move to when the current state expires.
  • ip_address (str or None) – IP address of the client.
  • tstp (str or None) – Time Sent To Partner of the lease info.
class com.vmware.vmc.model_client.InteractionPermissions(manage_permission=None, view_permission=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • manage_permission (bool or None) –
  • view_permission (bool or None) –
class com.vmware.vmc.model_client.InterfacesDashboardStats(vnic7_in_pkt=None, vnic0_in_byte=None, vnic8_out_pkt=None, vnic5_in_byte=None, vnic2_in_pkt=None, vnic3_in_pkt=None, vnic6_out_byte=None, vnic3_in_byte=None, vnic8_in_pkt=None, vnic1_in_byte=None, vnic1_out_pkt=None, vnic5_out_byte=None, vnic0_out_pkt=None, vnic0_out_byte=None, vnic6_out_pkt=None, vnic3_out_byte=None, vnic7_in_byte=None, vnic1_out_byte=None, vnic9_out_pkt=None, vnic9_in_pkt=None, vnic4_in_byte=None, vnic5_out_pkt=None, vnic2_out_pkt=None, vnic2_in_byte=None, vnic5_in_pkt=None, vnic7_out_pkt=None, vnic3_out_pkt=None, vnic4_out_pkt=None, vnic4_out_byte=None, vnic1_in_pkt=None, vnic2_out_byte=None, vnic6_in_byte=None, vnic0_in_pkt=None, vnic9_in_byte=None, vnic7_out_byte=None, vnic4_in_pkt=None, vnic9_out_byte=None, vnic8_out_byte=None, vnic8_in_byte=None, vnic6_in_pkt=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Dashboard Statistics data for Interfaces.

Tip

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

Parameters:
class com.vmware.vmc.model_client.IpAddresses(ip_address=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

IP address

Tip

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

Parameters:ip_address (list of str or None) – List of IP addresses.
class com.vmware.vmc.model_client.Ipsec(feature_type=None, logging=None, global_=None, enabled=None, sites=None, disable_event=None, version=None, template=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NSX Edge IPsec configuration details.

Tip

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

Parameters:
  • feature_type (str or None) –
  • logging (Logging or None) – Configure logging for the feature on NSX Edge appliance. Logging is disabled by default. Optional.
  • global (IpsecGlobalConfig or None) – IPsec Global configuration details.
  • enabled (bool or None) – Value is true if feature is enabled. Default value is true. Optional.
  • sites (IpsecSites or None) – IPsec Site configuration details.
  • disable_event (bool or None) – Enable/disable event generation on NSX Edge appliance for IPsec.
  • version (long or None) – Version number tracking each configuration change. To avoid problems with overwriting changes, always retrieve and modify the latest configuration to include the current version number in your request. If you provide a version number which is not current, the request is rejected. If you omit the version number, the request is accepted but may overwrite any current changes if your change is not in sync with the latest change. format: int64
  • template (str or None) –
class com.vmware.vmc.model_client.IpsecDashboardStats(ipsec_bytes_out=None, ipsec_bytes_in=None, ipsec_tunnels=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Dashboard Statistics data for Ipsec.

Tip

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

Parameters:
  • ipsec_bytes_out (list of DashboardStat or None) – Tx transmitted bytes.
  • ipsec_bytes_in (list of DashboardStat or None) – Rx received bytes.
  • ipsec_tunnels (list of DashboardStat or None) – Number of Ipsec tunnels.
class com.vmware.vmc.model_client.IpsecGlobalConfig(psk=None, ca_certificates=None, service_certificate=None, crl_certificates=None, extension=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

IPsec Global configuration details.

Tip

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

Parameters:
  • psk (str or None) – IPsec Global Pre Shared Key. Maximum characters is 128. Required when peerIp is configured as ‘any’ in NSX Edge IPsec Site configuration.
  • ca_certificates (CaCertificates or None) – CA certificate list. Optional.
  • service_certificate (str or None) – Certificate name or identifier. Required when x.509 is selected as the authentication mode.
  • crl_certificates (CrlCertificates or None) – CRL certificate list. Optional.
  • extension (str or None) –
class com.vmware.vmc.model_client.IpsecSite(psk=None, local_id=None, enable_pfs=None, authentication_mode=None, peer_subnets=None, dh_group=None, site_id=None, description=None, peer_ip=None, name=None, certificate=None, local_ip=None, encryption_algorithm=None, enabled=None, mtu=None, extension=None, peer_id=None, local_subnets=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NSX Edge IPsec Site configuration details.

Tip

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

Parameters:
  • psk (str or None) – Pre Shared Key for the IPsec Site. Required if Site peerIp is not ‘any’. Global PSK is used when Authentication mode is PSK and Site peerIp is ‘any’.
  • local_id (str or None) – Local ID of the IPsec Site. Defaults to the local IP.
  • enable_pfs (bool or None) – Enable/disable Perfect Forward Secrecy. Default is true.
  • authentication_mode (str or None) – Authentication mode for the IPsec Site. Valid values are psk and x.509, with psk as default.
  • peer_subnets (Subnets or None) – Peer subnets for which IPsec VPN is configured.
  • dh_group (str or None) – Diffie-Hellman algorithm group. Defaults to DH14 for FIPS enabled NSX Edge. DH2 and DH5 are not supported when FIPS is enabled on NSX Edge. Valid values are DH2, DH5, DH14, DH15, DH16.
  • site_id (str or None) – ID of the IPsec Site configuration provided by NSX Manager.
  • description (str or None) – Description of the IPsec Site.
  • peer_ip (str or None) – IP (IPv4) address or FQDN of the Peer. Can also be specified as ‘any’. Required.
  • name (str or None) – Name of the IPsec Site.
  • certificate (str or None) –
  • local_ip (str or None) – Local IP of the IPsec Site. Should be one of the IP addresses configured on the uplink interfaces of the NSX Edge. Required.
  • encryption_algorithm (str or None) – IPsec encryption algorithm with default as aes256. Valid values are ‘aes’, ‘aes256’, ‘3des’, ‘aes-gcm’.
  • enabled (bool or None) – Enable/disable IPsec Site.
  • mtu (long or None) – MTU for the IPsec site. Defaults to the mtu of the NSX Edge vnic specified by the localIp. Optional. format: int32
  • extension (str or None) –
  • peer_id (str or None) – Peer ID. Should be unique for all IPsec Site’s configured for an NSX Edge.
  • local_subnets (Subnets or None) – Local subnets for which IPsec VPN is configured.
class com.vmware.vmc.model_client.IpsecSiteIKEStatus(channel_status=None, channel_state=None, peer_ip_address=None, local_ip_address=None, peer_subnets=None, peer_id=None, last_informational_message=None, local_subnets=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • channel_status (str or None) –
  • channel_state (str or None) –
  • peer_ip_address (str or None) –
  • local_ip_address (str or None) –
  • peer_subnets (list of str or None) –
  • peer_id (str or None) –
  • last_informational_message (str or None) –
  • local_subnets (list of str or None) –
class com.vmware.vmc.model_client.IpsecSiteStats(rx_bytes_on_site=None, tunnel_stats=None, ike_status=None, site_status=None, tx_bytes_from_site=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • rx_bytes_on_site (long or None) –
  • tunnel_stats (list of IpsecTunnelStats or None) –
  • ike_status (IpsecSiteIKEStatus or None) –
  • site_status (str or None) –
  • tx_bytes_from_site (long or None) –
class com.vmware.vmc.model_client.IpsecSites(sites=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

List of IPsec sites for NSX Edge.

Tip

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

Parameters:sites (list of IpsecSite or None) –
class com.vmware.vmc.model_client.IpsecStatusAndStats(time_stamp=None, server_status=None, site_statistics=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • time_stamp (long or None) –
  • server_status (str or None) –
  • site_statistics (list of IpsecSiteStats or None) –
class com.vmware.vmc.model_client.IpsecTunnelStats(tunnel_status=None, peer_spi=None, rx_bytes_on_local_subnet=None, established_date=None, peer_subnet=None, authentication_algorithm=None, tunnel_state=None, tx_bytes_from_local_subnet=None, last_informational_message=None, local_spi=None, encryption_algorithm=None, local_subnet=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • tunnel_status (str or None) –
  • peer_spi (str or None) –
  • rx_bytes_on_local_subnet (long or None) –
  • established_date (str or None) –
  • peer_subnet (str or None) –
  • authentication_algorithm (str or None) –
  • tunnel_state (str or None) –
  • tx_bytes_from_local_subnet (long or None) –
  • last_informational_message (str or None) –
  • local_spi (str or None) –
  • encryption_algorithm (str or None) –
  • local_subnet (str or None) –
class com.vmware.vmc.model_client.KeyValueAttributes(value=None, key=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Key value pair describing the feature configuration limit.

Tip

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

Parameters:
  • value (str or None) – Value corresponding to the key of the configuration limit parameter.
  • key (str or None) – Key name of the configuration limit parameter.
class com.vmware.vmc.model_client.L2Extension(tunnel_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Layer 2 extension.

Tip

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

Parameters:tunnel_id (long) – Identifier for layer 2 extension tunnel. Valid range: 1-4093. format: int32
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 or None) – 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.L2vpnStats(tunnel_status=None, established_date=None, name=None, dropped_rx_packets=None, encryption_algorithm=None, failure_message=None, tx_bytes_from_local_subnet=None, rx_bytes_on_local_subnet=None, dropped_tx_packets=None, last_updated_time=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

L2 VPN status and statistics of a single L2 VPN site.

Tip

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

Parameters:
  • tunnel_status (str or None) – Status of the tunnel (UP/DOWN).
  • established_date (long or None) – Tunnel established date. format: int64
  • name (str or None) – User defined name of the site.
  • dropped_rx_packets (long or None) – Number of received packets dropped.
  • encryption_algorithm (str or None) – Cipher used in encryption.
  • failure_message (str or None) – Reason for the tunnel down.
  • tx_bytes_from_local_subnet (long or None) – Number of bytes transferred from local subnet.
  • rx_bytes_on_local_subnet (long or None) – Number of bytes received on the local subnet.
  • dropped_tx_packets (long or None) – Number of transferred packets dropped.
  • last_updated_time (long or None) – Time stamp of the statistics collection. format: int64
class com.vmware.vmc.model_client.L2vpnStatusAndStats(time_stamp=None, server_status=None, site_stats=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

L2 VPN status and statistics.

Tip

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

Parameters:
  • time_stamp (long or None) – Time stamp of statistics collection. format: int64
  • server_status (str or None) –
  • site_stats (list of L2vpnStats or None) – List of statistics for each Site.
class com.vmware.vmc.model_client.LicenceAclPermissions(data_permission=None, is_licensed=None, access_permission=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Licence and access control information for the feature.

Tip

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

Parameters:
  • data_permission (DataPermissions or None) – Data access control information for the feature.
  • is_licensed (bool or None) – Value is true if feature is licenced.
  • access_permission (InteractionPermissions or None) – Access control information for the feature.
class com.vmware.vmc.model_client.LoadBalancerDashboardStats(lb_bps_in=None, lb_http_reqs=None, lb_bps_out=None, lb_sessions=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Dashboard Statistics data for Load Balancer.

Tip

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

Parameters:
  • lb_bps_in (list of DashboardStat or None) – Number of bytes in.
  • lb_http_reqs (list of DashboardStat or None) – Number of HTTP requests received by Load Balancer.
  • lb_bps_out (list of DashboardStat or None) – Number of bytes out.
  • lb_sessions (list of DashboardStat or None) – Number of Load Balancer sessions.
class com.vmware.vmc.model_client.Logging(log_level=None, enable=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

logging.

Tip

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

Parameters:
  • log_level (str or None) – Log level. Valid values: emergency, alert, critical, error, warning, notice, info, debug.
  • enable (bool or None) – Logging enabled.
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.LogicalRouterScope(type=None, 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) –
  • id (str or None) –
class com.vmware.vmc.model_client.LogicalRouterScopes(logical_router_scope=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:logical_router_scope (list of LogicalRouterScope or None) –
class com.vmware.vmc.model_client.MacAddress(edge_vm_ha_index=None, value=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • edge_vm_ha_index (long or None) –
  • value (str or None) –
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.MetaDashboardStats(vnics=None, end_time=None, start_time=None, interval=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Start time, end time and interval details.

Tip

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

Parameters:
  • vnics (list of Vnic or None) – Statistics data is collected for these vNICs.
  • end_time (long or None) – End time in seconds. format: int64
  • start_time (long or None) – Start time in seconds. format: int64
  • interval (long or None) – Time interval in seconds. format: int32
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.Nat(rules=None, feature_type=None, version=None, enabled=None, template=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NAT configuration

Tip

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

Parameters:
  • rules (NatRules or None) – Ordered list of NAT rules.
  • feature_type (str or None) –
  • version (long or None) – Version number tracking each configuration change. To avoid problems with overwriting changes, always retrieve and modify the latest configuration to include the current version number in your request. If you provide a version number which is not current, the request is rejected. If you omit the version number, the request is accepted but may overwrite any current changes if your change is not in sync with the latest change. format: int64
  • enabled (bool or None) – Value is true if feature is enabled. Default value is true. Optional.
  • template (str or None) –
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.NatRules(nat_rules_dtos=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Ordered list of NAT rules.

Tip

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

Parameters:nat_rules_dtos (list of Nsxnatrule or None) – Ordered list of NAT rules.
class com.vmware.vmc.model_client.NetworkingTemplate(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.Nsxfirewallrule(rule_type=None, description=None, rule_id=None, match_translated=None, invalid_application=None, direction=None, statistics=None, name=None, invalid_source=None, logging_enabled=None, destination=None, enabled=None, application=None, source=None, action=None, invalid_destination=None, rule_tag=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Firewall Rule

Tip

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

Parameters:
  • rule_type (str or None) – Identifies the type of the rule. internal_high or user.
  • description (str or None) – Description for the rule
  • rule_id (long or None) – Identifier for the rule. format: int64
  • match_translated (bool or None) – Defines the order of NAT and Firewall pipeline. When false, firewall happens before NAT. Default : false
  • invalid_application (bool or None) –
  • direction (str or None) – Direction. Possible values in or out. Default is ‘any’.
  • statistics (FirewallRuleStats or None) – Statistics for the rule
  • name (str or None) – Name for the rule.
  • invalid_source (bool or None) –
  • logging_enabled (bool or None) – Enable logging for the rule.
  • destination (AddressFWSourceDestination or None) – List of destinations. Default is any.
  • enabled (bool or None) – Enable rule.
  • application (Application or None) – List of applications. Default is any.
  • source (AddressFWSourceDestination or None) – List of sources. Default is any.
  • action (str or None) – Action. Values : accept, deny
  • invalid_destination (bool or None) –
  • rule_tag (long or None) – Rule tag. Used to specify user-defined ruleId. If not specified NSX Manager will generate ruleId. format: int64
class com.vmware.vmc.model_client.Nsxfirewallservice(source_port=None, protocol=None, port=None, icmp_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Application (service) for firewall rule.

Tip

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

Parameters:
  • source_port (list of str or None) – List of source ports.
  • protocol (str or None) – Protocol.
  • port (list of str or None) – List of destination ports.
  • icmp_type (str or None) – IcmpType. Only supported when protocol is icmp. Default is ‘any’.
class com.vmware.vmc.model_client.Nsxl2vpn(listener_ips=None, enabled=None, sites=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

L2 VPN server configuration.

Tip

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

Parameters:
  • listener_ips (list of str) – Listener IP addresses.
  • enabled (bool or None) – Enabled state of L2 VPN service.
  • sites (Sites) – List of L2 VPN sites.
class com.vmware.vmc.model_client.Nsxnatrule(vnic=None, rule_type=None, protocol=None, description=None, rule_id=None, snat_match_destination_port=None, original_address=None, dnat_match_source_address=None, dnat_match_source_port=None, snat_match_destination_address=None, original_port=None, logging_enabled=None, translated_address=None, enabled=None, icmp_type=None, translated_port=None, action=None, rule_tag=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NAT rule

Tip

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

Parameters:
  • vnic (str or None) – Interface on which the NAT rule is applied.
  • rule_type (str or None) – Identifies the type of the rule. internal_high or user.
  • protocol (str or None) – Protocol. Default is ‘any’
  • description (str or None) – Description for the rule.
  • rule_id (long or None) – Identifier for the rule. format: int64
  • snat_match_destination_port (str or None) – Apply SNAT rule only if traffic has this destination port. Default is ‘any’.
  • original_address (str or None) – Original address or address range. This is the original source address for SNAT rules and the original destination address for DNAT rules.
  • dnat_match_source_address (str or None) – Apply DNAT rule only if traffic has this source address. Default is ‘any’.
  • dnat_match_source_port (str or None) – Apply DNAT rule only if traffic has this source port. Default is ‘any’.
  • snat_match_destination_address (str or None) – Apply SNAT rule only if traffic has this destination address. Default is ‘any’.
  • original_port (str or None) – Original port. This is the original source port for SNAT rules, and the original destination port for DNAT rules.
  • logging_enabled (bool or None) – Enable logging for the rule.
  • translated_address (str or None) – Translated address or address range.
  • enabled (bool or None) – Enable rule.
  • icmp_type (str or None) – ICMP type. Only supported when protocol is icmp. Default is ‘any’.
  • translated_port (str or None) – Translated port. Supported in DNAT rules only.
  • action (str or None) – Action for the rule. SNAT or DNAT.
  • rule_tag (long or None) – Rule tag. Used to specify user-defined ruleId. If not specified NSX Manager will generate ruleId. format: int64
class com.vmware.vmc.model_client.Nsxsite(secure_traffic=None, site_id=None, name=None, password=None, user_id=None, description=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

L2 VPN site.

Tip

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

Parameters:
  • secure_traffic (bool or None) – Secure L2VPN traffic.
  • site_id (str or None) – Identifier for L2 VPN site.
  • name (str or None) – Name of L2 VPN site. Length: 1-255 characters.
  • password (str or None) – Password for L2 VPN user. Passwords must contain the following: 12-63 characters, a mix of upper case letters, lower case letters, numbers, and at least one special character. Password must not contain the username as a substring. Do not repeat a character 3 or more times.
  • user_id (str or None) – L2 VPN user ID. Valid user names: 1-63 characters, letters and numbers only. No white space or special characters.
  • description (str or None) – Description of L2 VPN site.
class com.vmware.vmc.model_client.ObjectType(name=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) –
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.OfferType(string)

Bases: vmware.vapi.bindings.enum.Enum

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the OfferType instance.
ON_DEMAND = OfferType(string='ON_DEMAND')
TERM = OfferType(string='TERM')
class com.vmware.vmc.model_client.OnDemandOfferInstance(product_type=None, name=None, currency=None, region=None, unit_price=None, monthly_cost=None, version=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_type (str) –
  • name (str) –
  • currency (str) –
  • region (str) –
  • unit_price (str) –
  • monthly_cost (str) –
  • version (str) –
  • description (str) –
class com.vmware.vmc.model_client.OrgConfiguration(provider='OrgConfiguration')

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:provider (str) –

Possible values are:

Discriminator for provider specific properties
PROVIDER_AWS = 'AWS'
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.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, sla=None, project_state=None, properties=None, cloud_configurations=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
PROJECT_STATE_CREATED = 'CREATED'
PROJECT_STATE_DELETED = 'DELETED'
SLA_CUSTOMER = 'CUSTOMER'
SLA_INTERNAL_CUSTOMER = 'INTERNAL_CUSTOMER'
SLA_SECOND_PARTY_PARTNER = 'SECOND_PARTY_PARTNER'
SLA_THIRD_PARTY_PARTNER = 'THIRD_PARTY_PARTNER'
SLA_VMC_INTERNAL = 'VMC_INTERNAL'
class com.vmware.vmc.model_client.PagedEdgeList(edge_page=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NSX Edges listed by pages.

Tip

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

Parameters:edge_page (DataPageEdgeSummary or None) – Page details with matched records.
class com.vmware.vmc.model_client.PagingInfo(sort_order_ascending=None, total_count=None, start_index=None, sort_by=None, page_size=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • sort_order_ascending (bool or None) –
  • total_count (long or None) –
  • start_index (long or None) –
  • sort_by (str or None) –
  • page_size (long or None) –
class com.vmware.vmc.model_client.PopAmiInfo(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:
  • 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, created_at=None, id=None, service_infos=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].
  • created_at (datetime.datetime or None) – The PopInfo (or PoP AMI) created time. Using ISO 8601 date-time pattern. format: date-time
  • id (str or None) – UUID of the PopInfo format: UUID
  • service_infos ((dict of str and PopServiceInfo) or None) – A map of [service type]:[PopServiceInfo]
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:
SERVICE_AGENT = 'AGENT'
SERVICE_AIDE = 'AIDE'
SERVICE_BRE = 'BRE'
SERVICE_BRF = 'BRF'
SERVICE_DNS = 'DNS'
SERVICE_DOCKER = 'DOCKER'
SERVICE_FM_LOG_COLLECTOR = 'FM_LOG_COLLECTOR'
SERVICE_FM_MANAGEMENT = 'FM_MANAGEMENT'
SERVICE_FM_METRICS_COLLECTOR = 'FM_METRICS_COLLECTOR'
SERVICE_FORWARD_PROXY = 'FORWARD_PROXY'
SERVICE_GLCM = 'GLCM'
SERVICE_JRE = 'JRE'
SERVICE_LOGZ_LOG_COLLECTOR = 'LOGZ_LOG_COLLECTOR'
SERVICE_NTP = 'NTP'
SERVICE_OS = 'OS'
SERVICE_REVERSE_PROXY = 'REVERSE_PROXY'
SERVICE_RTS = 'RTS'
SERVICE_S3_ADAPTER = 'S3_ADAPTER'
class com.vmware.vmc.model_client.Requests(total=None, queries=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DNS request statistics.

Tip

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

Parameters:
  • total (long or None) –
  • queries (long or None) –
class com.vmware.vmc.model_client.Result(value=None, key=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Job result information for the configuration change carried out on NSX Edge.

Tip

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

Parameters:
  • value (str or None) – Job Result value associated with key ID.
  • key (str or None) – Job Result key ID.
class com.vmware.vmc.model_client.ScopeInfo(object_type_name=None, id=None, name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • object_type_name (str or None) –
  • id (str or None) –
  • name (str or None) –
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, 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'
SDDC_STATE_DELETED = 'DELETED'
SDDC_STATE_DELETING = 'DELETING'
SDDC_STATE_DELETION_FAILED = 'DELETION_FAILED'
SDDC_STATE_DEPLOYING = 'DEPLOYING'
SDDC_STATE_FAILED = 'FAILED'
SDDC_STATE_READY = 'READY'
class com.vmware.vmc.model_client.SddcAllocatePublicIpSpec(count=None, private_ips=None, names=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • count (long) –
  • private_ips (list of str or None) – List of workload VM private IPs to be assigned the public IP just allocated.
  • names (list of str or None) – List of names for the workload VM public IP assignment.
class com.vmware.vmc.model_client.SddcConfig(name=None, account_link_sddc_config=None, vpc_cidr=None, num_hosts=None, sddc_type=None, vxlan_subnet=None, account_link_config=None, provider='SddcConfig', sso_domain=None, sddc_template_id=None, deployment_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • name (str) –
  • account_link_sddc_config (list of AccountLinkSddcConfig or None) – A list of the SDDC linking configurations to use.
  • vpc_cidr (str or None) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.
  • num_hosts (long) –
  • sddc_type (str or None) – Denotes the sddc type , if the value is null or empty, the type is considered as default.
  • vxlan_subnet (str or None) – VXLAN IP subnet
  • account_link_config (AccountLinkConfig or None) – The account linking configuration, we will keep this one and remove accountLinkSddcConfig finally.
  • 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.
  • sddc_template_id (str or None) – If provided, configuration from the template will applied to the provisioned SDDC. format: UUID
  • 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'
PROVIDER_AWS = 'AWS'
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.SddcManifest(vmc_version=None, glcm_bundle=None, pop_info=None, vmc_internal_version=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
  • esx_ami (AmiInfo or None) –
  • esx_nsxt_ami (AmiInfo or None) –
  • metadata (Metadata or None) –
class com.vmware.vmc.model_client.SddcNetwork(subnets=None, cgw_name=None, name=None, l2_extension=None, cgw_id=None, dhcp_configs=None, id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Logical network.

Tip

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

Parameters:
  • subnets (SddcNetworkAddressGroups or None) – Network address groups for routed logical networks.
  • cgw_name (str or None) – Name of the compute gateway to which the logical network is attached.
  • name (str) – Name of logical network. Length needs to be between 1-35 characters.
  • l2_extension (L2Extension or None) – Layer 2 extension for extended logical networks.
  • cgw_id (str) – ID of the compute gateway edge to which the logical network is attached.
  • dhcp_configs (SddcNetworkDhcpConfig or None) – DHCP configuration for routed logical networks.
  • id (str or None) – ID of logical network.
class com.vmware.vmc.model_client.SddcNetworkAddressGroup(prefix_length=None, primary_address=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Logical Network address group.

Tip

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

Parameters:
  • prefix_length (str or None) – Prefix length of logical network.
  • primary_address (str or None) – Primary address for logical network.
class com.vmware.vmc.model_client.SddcNetworkAddressGroups(address_groups=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Logical network address groups.

Tip

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

Parameters:address_groups (list of SddcNetworkAddressGroup or None) – List of logical network address groups.
class com.vmware.vmc.model_client.SddcNetworkDhcpConfig(ip_pools=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DHCP configuration for the logical network.

Tip

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

Parameters:ip_pools (list of SddcNetworkDhcpIpPool or None) – List of IP pools in DHCP configuration.
class com.vmware.vmc.model_client.SddcNetworkDhcpIpPool(ip_range=None, domain_name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

DHCP IP pool for logical network.

Tip

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

Parameters:
  • ip_range (str or None) – IP range for DHCP IP pool.
  • domain_name (str or None) – DNS domain name.
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(nsxt=None, mgw_id=None, nsx_mgr_url=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, management_ds=None, custom_properties=None, cloud_password=None, provider='SddcResourceConfig', clusters=None, vc_management_ip=None, sddc_networks=None, cloud_username=None, esx_hosts=None, nsx_mgr_management_ip=None, vc_instance_id=None, esx_cluster_id=None, vc_public_ip=None, vc_url=None, sddc_manifest=None, vxlan_subnet=None, cloud_user_group=None, management_rp=None, witness_availability_zone=None, sso_domain=None, deployment_type=None, dns_with_management_vm_private_ip=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • nsxt (bool or None) – if true, NSX-T UI is enabled.
  • mgw_id (str or None) – Management Gateway Id
  • nsx_mgr_url (str or None) – URL of the NSX Manager
  • 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.
  • management_ds (str or None) – The ManagedObjectReference of the management Datastore
  • custom_properties ((dict of str and str) or None) –
  • cloud_password (str or None) – Password for vCenter SDDC administrator
  • provider (str) –

    Possible values are:

    Discriminator for additional properties
  • clusters (list of vmware.vapi.struct.VapiStruct or None) – List of clusters in the SDDC. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in Cluster. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in Cluster.
  • vc_management_ip (str or None) – vCenter internal management IP
  • sddc_networks (list of str or None) –
  • cloud_username (str or None) – Username for vCenter SDDC administrator
  • esx_hosts (list of AwsEsxHost or None) –
  • nsx_mgr_management_ip (str or None) – NSX Manager internal management IP
  • vc_instance_id (str or None) – unique id of the vCenter server
  • esx_cluster_id (str or None) – Cluster Id to add ESX workflow
  • vc_public_ip (str or None) – vCenter public IP
  • vc_url (str or None) – URL of the vCenter server
  • sddc_manifest (SddcManifest or None) –
  • vxlan_subnet (str or None) – VXLAN IP subnet
  • 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.
  • sso_domain (str or None) – The SSO domain name to use for vSphere users
  • deployment_type (str or None) –

    Possible values are:

    Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.
  • dns_with_management_vm_private_ip (bool or None) – if true, use the private IP addresses to register DNS records for the management VMs
DEPLOYMENT_TYPE_MULTIAZ = 'MultiAZ'
DEPLOYMENT_TYPE_SINGLEAZ = 'SingleAZ'
PROVIDER_AWS = 'AWS'
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, name=None, tenant_id=None, source_sddc_id=None, state=None, num_hosts=None, public_ips=None, vpc_cidr=None, provider=None, vc_public_ip=None, sso_domain=None, networking_template=None, region=None, vc_url=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
PROVIDER_AWS = 'AWS'
STATE_APPLIED = 'APPLIED'
STATE_AVAILABLE = 'AVAILABLE'
STATE_DELETED = 'DELETED'
STATE_DELETING = 'DELETING'
STATE_FAILED = 'FAILED'
STATE_INUSE = 'INUSE'
class com.vmware.vmc.model_client.SecondaryAddresses(type=None, ip_address=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Secondary IP addresses of the NSX Edge vnic address group. These are used for NAT, LB, VPN etc. Optional.

Tip

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

Parameters:
  • type (str or None) –
  • ip_address (list of str or None) – List of IP addresses.
class com.vmware.vmc.model_client.ServiceError(original_service=None, params=None, default_message=None, original_service_error_code=None, error_code=None, localized_message=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:
  • original_service (str) – The original service name of the error.
  • params (list of str or None) – The parameters of the service error.
  • default_message (str or None) – Error message in English.
  • original_service_error_code (str) – The original error code of the service.
  • error_code (str) – Localizable error code.
  • localized_message (str or None) – The localized message.
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.Sites(sites=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

L2 VPN sites.

Tip

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

Parameters:sites (list of Nsxsite or None) –
class com.vmware.vmc.model_client.SslvpnDashboardStats(active_clients=None, sslvpn_bytes_in=None, auth_failures=None, sessions_created=None, sslvpn_bytes_out=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Dashboard Statistics data for SSL VPN.

Tip

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

Parameters:
  • active_clients (list of DashboardStat or None) – Number of active clients.
  • sslvpn_bytes_in (list of DashboardStat or None) – Rx bytes received for SSL VPN.
  • auth_failures (list of DashboardStat or None) – Number of authentication failures.
  • sessions_created (list of DashboardStat or None) – Number of SSL VPN sessions created.
  • sslvpn_bytes_out (list of DashboardStat or None) – Tx bytes transmitted for SSL VPN.
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.SubInterface(index=None, tunnel_id=None, name=None, address_groups=None, vlan_id=None, label=None, logical_switch_name=None, is_connected=None, mtu=None, logical_switch_id=None, enable_send_redirects=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NSX Edge sub interface configuration details. Sub interfaces are created on a trunk interface.

Tip

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

Parameters:
  • index (long or None) – Index of the sub interface assigned by NSX Manager. Min value is 10 and max value is 4103. format: int32
  • tunnel_id (long) – Valid values for tunnel ID are min 1 to max 4093. Required. format: int32
  • name (str or None) – Name of the sub interface. Required.
  • address_groups (EdgeVnicAddressGroups or None) – Address group configuration of the sub interface.
  • vlan_id (long or None) – VLAN ID of the virtual LAN used by this sub interface. VLAN IDs can range from 0 to 4094. format: int32
  • label (str or None) – Sub interface label of format vNic_{index} provided by NSX Manager. Read only.
  • logical_switch_name (str or None) – Name of the logical switch connected to this sub interface.
  • is_connected (bool or None) – Value is true if the sub interface is connected to a logical switch, standard portgroup or distributed portgroup.
  • mtu (long or None) – MTU value of the sub interface. This value would be the least mtu for all the trunk interfaces of the NSX Edge. Default is 1500. format: int32
  • logical_switch_id (str or None) – ID of the logical switch connected to this sub interface.
  • enable_send_redirects (bool or None) – Value is true if send redirects is enabled. Enable ICMP redirect to convey routing information to hosts.
class com.vmware.vmc.model_client.SubInterfaces(sub_interfaces=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:sub_interfaces (list of SubInterface or None) – List of sub interfaces.
class com.vmware.vmc.model_client.Subnets(subnets=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:subnets (list of str or None) – List of subnets for which IPsec VPN is configured. Subnets should be network address specified in CIDR format and can accept ‘0.0.0.0/0’ (any)
class com.vmware.vmc.model_client.SubscriptionDetails(status=None, anniversary_billing_date=None, end_date=None, auto_renewed_allowed=None, description=None, commitment_term=None, csp_subscription_id=None, billing_subscription_id=None, commitment_term_uom=None, offer_version=None, region=None, offer_name=None, offer_type=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:
STATUS_ACTIVATED = 'ACTIVATED'
STATUS_CANCELLED = 'CANCELLED'
STATUS_CREATED = 'CREATED'
STATUS_EXPIRED = 'EXPIRED'
STATUS_FAILED = 'FAILED'
STATUS_PENDING_PROVISIONING = 'PENDING_PROVISIONING'
class com.vmware.vmc.model_client.SubscriptionRequest(offer_version=None, product_type=None, region=None, commitment_term=None, offer_name=None, quantity=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • offer_version (str) –
  • product_type (str) –
  • region (str) –
  • commitment_term (str) –
  • offer_name (str) –
  • quantity (long) –
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, resource_id=None, start_time=None, service_errors=None, sub_status=None, task_type=None, task_progress_phases=None, error_message=None, org_id=None, progress_percent=None, estimated_remaining_minutes=None, params=None, end_time=None, phase_in_progress=None, task_version=None, resource_type=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:

  • resource_id (str or None) – UUID of resources task is acting upon
  • start_time (datetime.datetime or None) –
  • service_errors (list of ServiceError or None) – Service errors returned from SDDC services.
  • sub_status (str or None) –
  • task_type (str 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) –
  • progress_percent (long or None) – Estimated progress percentage the task executed format: int32
  • 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) –
  • end_time (datetime.datetime or None) –
  • phase_in_progress (str or None) – The current in progress phase ID in the task execution, if none in progress, empty string returned.
  • task_version (str or None) –
  • resource_type (str or None) – Type of resource being acted upon
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.TermOfferInstance(product_type=None, name=None, region=None, commitment_term=None, unit_price=None, currency=None, version=None, description=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:
  • product_type (str) –
  • name (str) –
  • region (str) –
  • commitment_term (long) –
  • unit_price (str) –
  • currency (str) –
  • version (str) –
  • description (str) –
class com.vmware.vmc.model_client.TrafficShapingPolicy(burst_size=None, average_bandwidth=None, peak_bandwidth=None, enabled=None, inherited=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • burst_size (long or None) –
  • average_bandwidth (long or None) –
  • peak_bandwidth (long or None) –
  • enabled (bool or None) –
  • inherited (bool or None) –
class com.vmware.vmc.model_client.Vnic(sub_interfaces=None, address_groups=None, is_connected=None, enable_send_redirects=None, in_shaping_policy=None, label=None, enable_proxy_arp=None, index=None, name=None, mtu=None, fence_parameters=None, mac_addresses=None, out_shaping_policy=None, portgroup_name=None, enable_bridge_mode=None, type=None, portgroup_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

NSX Edge vnic configuration details.

Tip

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

Parameters:
  • sub_interfaces (SubInterfaces or None) – List of sub interfaces. Sub interfaces can be created only on a trunk interface.
  • address_groups (EdgeVnicAddressGroups or None) – Address group configuration of the interface.
  • is_connected (bool or None) – Value is true if the vnic is connected to a logical switch, standard portgroup or distributed portgroup.
  • enable_send_redirects (bool or None) – Value is true if send redirects is enabled. Enable ICMP redirect to convey routing information to hosts.
  • in_shaping_policy (TrafficShapingPolicy or None) –
  • label (str or None) – Interface label of format vNic_{vnicIndex} provided by NSX Manager. Read only.
  • enable_proxy_arp (bool or None) – Value is true if proxy arp is enabled. Enable proxy ARP if you want to allow the NSX Edge of type ‘gatewayServices’ to answer ARP requests intended for other machines.
  • index (long) – Index of the vnic. Min value is 0 and max value is 9. format: int32
  • name (str or None) – Name of the interface. Optional.
  • mtu (long or None) – MTU of the interface, with default as 1500. Min is 68, Max is 9000. Optional. format: int32
  • fence_parameters (list of KeyValueAttributes or None) –
  • mac_addresses (list of MacAddress or None) – Distinct MAC addresses configured for the vnic. Optional.
  • out_shaping_policy (TrafficShapingPolicy or None) –
  • portgroup_name (str or None) – Name of the port group or logical switch.
  • enable_bridge_mode (bool or None) – Value is true if bridge mode is enabled.
  • type (str or None) – Type of the vnic. Values are uplink, internal, trunk. At least one internal interface must be configured for NSX Edge HA to work.
  • portgroup_id (str or None) – Value are port group ID (standard portgroup or distributed portgroup) or virtual wire ID (logical switch). Logical switch cannot be used for a TRUNK vnic. Portgroup cannot be shared among vnics/LIFs. Required when isConnected is specified as true. Example ‘network-17’ (standard portgroup), ‘dvportgroup-34’ (distributed portgroup) or ‘virtualwire-2’ (logical switch).
class com.vmware.vmc.model_client.Vnics(vnics=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Ordered list of NSX Edge vnics. Until one connected vnic is configured, none of the configured features will serve the network.

Tip

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

Parameters:vnics (list of Vnic or None) – Ordered list of NSX Edge vnics.
class com.vmware.vmc.model_client.VpcInfo(vpc_cidr=None, vm_security_group_id=None, route_table_id=None, edge_subnet_id=None, id=None, api_association_id=None, private_subnet_id=None, api_subnet_id=None, esx_security_group_id=None, subnet_id=None, internet_gateway_id=None, security_group_id=None, association_id=None, vgw_route_table_id=None, edge_association_id=None, vif_ids=None, peering_connection_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters:
  • vpc_cidr (str or None) –
  • vm_security_group_id (str or None) –
  • route_table_id (str or None) –
  • edge_subnet_id (str or None) – Id of the NSX edge associated with this VPC
  • id (str or None) –
  • api_association_id (str or None) – Id of the association between subnet and route-table
  • private_subnet_id (str or None) –
  • api_subnet_id (str or None) – Id associated with this VPC
  • esx_security_group_id (str or None) –
  • subnet_id (str or None) –
  • internet_gateway_id (str or None) –
  • security_group_id (str or None) –
  • association_id (str or None) –
  • vgw_route_table_id (str or None) – Route table which contains the route to VGW
  • edge_association_id (str or None) – Id of the association between edge subnet and route-table
  • vif_ids (list of str or None) –
  • peering_connection_id (str 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)

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'
ENCRYPTION_AES = 'AES'
ENCRYPTION_AES256 = 'AES256'
ENCRYPTION_AES_GCM = 'AES_GCM'
ENCRYPTION_TRIPLE_DES = 'TRIPLE_DES'
ENCRYPTION_UNKNOWN = 'UNKNOWN'
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) –

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.
create(org)

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

Parameters:org (str) – Organization identifier. (required)
Raise:com.vmware.vapi.std.errors_client.Error Generic Error
class com.vmware.vmc.orgs_client.OfferInstances(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(org, region, product_type)

List all offers available for the specific product type in the specific region

Parameters:
  • org (str) – Organization identifier. (required)
  • region (str) – Region for the offer (required)
  • product_type (str) – Type of the product in offers (required)
Return type:

com.vmware.vmc.model_client.OfferInstancesHolder
Returns:

com.vmware.vmc.model.OfferInstancesHolder
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request. Type of the product not supported.
Raise:

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

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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.Unauthorized Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound Organization doesn’t exist
Raise:com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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.Unauthorized Forbidden
Raise:

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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.Unauthorized Forbidden
Raise:

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

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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.Unauthorized Forbidden
Raise:com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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)

Provision an SDDC in target cloud

Parameters:
Return type:

com.vmware.vmc.model_client.Task
Returns:

com.vmware.vmc.model.Task
Raise:

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

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
delete(org, sddc, retain_configuration=None, template_name=None)

Delete SDDC

Parameters:
  • org (str) – Organization identifier. (required)
  • sddc (str) – Sddc Identifier. (required)
  • retain_configuration (str 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)
Return type:

com.vmware.vmc.model_client.Task
Returns:

com.vmware.vmc.model.Task
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
Raise:

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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.Unauthorized Forbidden
Raise:

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

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
list(org)

List all the SDDCs of an organization

Parameters:org (str) – Organization identifier. (required)
Return type:list of com.vmware.vmc.model_client.Sddc
Returns:
Raise:com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise:com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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.InternalServerError Server error. Check retryable flag to see if request should be retried.
Raise:

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

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
delete(org, subscription)

Initiates subscription cancellation. Returns Task object.

Parameters:
  • org (str) – Organization identifier. (required)
  • subscription (str) – SubscriptionId for an sddc. (required)
Return type:

com.vmware.vmc.model_client.Task
Returns:

com.vmware.vmc.model.Task
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request. Check if the subscription id is still valid and if the Sddc is in a state that can be deleted. More information will be available in the error_messages field.
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.Unauthorized Forbidden
Raise:

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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 all 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.InternalServerError Server error. Check retryable flag to see if request should be retried.
Raise:

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

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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 Id (required)
Return type:

com.vmware.vmc.model_client.Task
Returns:

com.vmware.vmc.model.Task
Raise:

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

com.vmware.vapi.std.errors_client.NotFound Cannot find the task with given identifier
Raise:

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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’ Nested attributes are composed using ‘.’ Dates must be formatted as YYYY-MM-DD 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. NOTE: currently only ANDs of ORs is implemented. NOTE2: currently only range operators are implemented for created date. Examples: - $filter=(created gt ‘2016-08-09’) 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.Unauthorized Forbidden
Raise:

com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized
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 Id (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.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
Raise:

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