com.vmware.vmc.orgs package

Subpackages

• com.vmware.vmc.orgs.sddcs package
  • Subpackages
    • com.vmware.vmc.orgs.sddcs.networks package
      • Subpackages
        • com.vmware.vmc.orgs.sddcs.networks.cgws package
          • Submodules
          • com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client module
        • com.vmware.vmc.orgs.sddcs.networks.edges package
          • Subpackages
            • com.vmware.vmc.orgs.sddcs.networks.edges.firewall package
              • Submodules
              • com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client module
            • com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package
              • Submodules
              • com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client module
            • com.vmware.vmc.orgs.sddcs.networks.edges.nat package
              • Submodules
              • com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client module
            • com.vmware.vmc.orgs.sddcs.networks.edges.statistics package
              • Submodules
              • com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client module
              • com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client module
          • Submodules
          • com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client module
          • com.vmware.vmc.orgs.sddcs.networks.edges.dns_client module
          • com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client module
          • com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client module
          • com.vmware.vmc.orgs.sddcs.networks.edges.nat_client module
          • com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client module
      • Submodules
      • com.vmware.vmc.orgs.sddcs.networks.edges_client module
  • Submodules
  • com.vmware.vmc.orgs.sddcs.dns_client module
  • com.vmware.vmc.orgs.sddcs.mgw_client module
  • com.vmware.vmc.orgs.sddcs.networks_client module

Submodules

com.vmware.vmc.orgs.account_link_client module

class com.vmware.vmc.orgs.account_link_client.CompatibleSubnets(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(org, linked_account_id=None, region=None)

Gets a customer’s compatible subnets for account linking

Parameters:

• org (str) – Organization identifier. (required)
• linked_account_id (str or None) – The linked connected account identifier (optional)
• region (str or None) – The region of the cloud resources to work in (optional)

Return type:

com.vmware.vmc.model_client.AwsCompatibleSubnets

Returns:

com.vmware.vmc.model.AwsCompatibleSubnets

Raise:

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

Raise:

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

post(org)

Sets which subnet to use to link accounts and finishes the linking process

Parameters:org (str) – Organization identifier. (required) Return type:com.vmware.vmc.model_client.AwsSubnet Returns:com.vmware.vmc.model.AwsSubnet Raise:com.vmware.vapi.std.errors_client.Unauthorized Forbidden Raise:com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

class com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(org, linked_account_id=None, region=None)

Gets a customer’s compatible subnets for account linking via a task. The information is returned as a member of the task (found in task.params[‘subnet_list_result’] when you are notified it is complete), and it’s documented under ref /definitions/AwsCompatibleSubnets

Parameters:

• org (str) – Organization identifier. (required)
• linked_account_id (str or None) – The linked connected account identifier (optional)
• region (str or None) – The region of the cloud resources to work in (optional)

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

post(aws_subnet, org)

Sets which subnet to use to link accounts and finishes the linking process via a task

Parameters:

• aws_subnet (com.vmware.vmc.model_client.AwsSubnet) – The subnet chosen by the customer (required)
• org (str) – Organization 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

class com.vmware.vmc.orgs.account_link_client.ConnectedAccounts(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(org, linked_account_path_id, force_even_when_sddc_present=None)

Delete a particular connected (linked) account.

Parameters:

• org (str) – Organization identifier. (required)
• linked_account_path_id (str) – The linked connected account identifier (required)
• force_even_when_sddc_present (bool or None) – When true, forcibly removes a connected account even when SDDC’s are still linked to it. (optional)

Return type:

com.vmware.vmc.model_client.AwsCustomerConnectedAccount

Returns:

com.vmware.vmc.model.AwsCustomerConnectedAccount

Raise:

com.vmware.vapi.std.errors_client.InvalidRequest An invalid connected account ID was specified, or the connection still has SDDCs active on it.

Raise:

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

Raise:

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

get(org)

Get a list of connected accounts

Parameters:org (str) – Organization identifier. (required) Return type:list of com.vmware.vmc.model_client.AwsCustomerConnectedAccount Returns: Raise:com.vmware.vapi.std.errors_client.Unauthorized Forbidden Raise:com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

class com.vmware.vmc.orgs.account_link_client.MapCustomerZones(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

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

post(org, map_zones_request)

Creates a task to re-map customer’s datacenters across zones.

Parameters:

• org (str) – Organization identifier. (required)
• map_zones_request (com.vmware.vmc.model_client.MapZonesRequest) – The zones request information about who to map and what to map. (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

class com.vmware.vmc.orgs.account_link_client.SddcConnections(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(org, sddc=None)

Get a list of SDDC connections currently setup for the customer’s organization.

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str or None) – sddc (optional)

Return type:

list of com.vmware.vmc.model_client.AwsSddcConnection

Returns:

Raise:

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

Raise:

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

class com.vmware.vmc.orgs.account_link_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

com.vmware.vmc.orgs.sddcs_client module

class com.vmware.vmc.orgs.sddcs_client.Clusters(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, cluster_config)

Add a cluster in the target sddc

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str) – Sddc Identifier. (required)
• cluster_config (com.vmware.vmc.model_client.ClusterConfig) – clusterConfig (required)

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 updates

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 cluster with the given identifier

Raise:

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

delete(org, sddc, cluster)

This is a force operation which will delete the cluster even if there can be a data loss. Before calling this operation, all the VMs should be powered off.

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str) – Sddc Identifier. (required)
• cluster (str) – cluster identifier (required)

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 updates

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 cluster with the given id

Raise:

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

class com.vmware.vmc.orgs.sddcs_client.Convert(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)

This API converts a one host SDDC to a four node DEFAULT SDDC. It takes care of configuring and upgrading the vCenter configurations on the SDDC for high availability and data redundancy.

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str) – Sddc Identifier. (required)

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 updates, Method not allowed

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

class com.vmware.vmc.orgs.sddcs_client.Esxs(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, esx_config, action=None)

Add/Remove one or more ESX hosts in the target cloud

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str) – Sddc Identifier. (required)
• esx_config (com.vmware.vmc.model_client.EsxConfig) – esxConfig (required)
• action (str or None) – If = ‘add’, will add the esx. If = ‘remove’, will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = ‘force-remove’, will delete the esx even if it can lead to data loss (This is an privileged operation). If = ‘addToAll’, will add esxs to all clusters in the SDDC (This is an privileged operation). If = ‘removeFromAll’, will delete the esxs from all clusters in the SDDC (This is an privileged operation). Default behaviour is ‘add’ (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 updates

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 the given identifier

Raise:

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

class com.vmware.vmc.orgs.sddcs_client.Publicips(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, spec)

Allocate public IPs for a SDDC

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str) – Sddc Identifier. (required)
• spec (com.vmware.vmc.model_client.SddcAllocatePublicIpSpec) – allocation spec (required)

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 updates

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

delete(org, sddc, id)

Free one public IP for a SDDC

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str) – Sddc Identifier. (required)
• id (str) – ip allocation id (required)

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 updates

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 public IP with given IP address

Raise:

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

get(org, sddc, id)

Get one public IP for a SDDC

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str) – Sddc Identifier. (required)
• id (str) – ip allocation id (required)

Return type:

com.vmware.vmc.model_client.SddcPublicIp

Returns:

com.vmware.vmc.model.SddcPublicIp

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.NotFound Cannot find the public IP with given IP address

Raise:

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

list(org, sddc)

list all public IPs for a SDDC

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str) – Sddc Identifier. (required)

Return type:

list of com.vmware.vmc.model_client.SddcPublicIp

Returns:

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

update(org, sddc, id, action, sddc_public_ip_object)

Attach or detach a public IP to workload VM for a SDDC

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str) – Sddc Identifier. (required)
• id (str) – ip allocation id (required)
• action (str) – Type of action as ‘attach’, ‘detach’, ‘reattach’, or ‘rename’. For ‘attch’, the public IP must not be attached and ‘associated_private_ip’ in the payload needs to be set with a workload VM private IP. For ‘detach’, the public IP must be attached and ‘associated_private_ip’ in the payload should not be set with any value. For ‘reattach’, the public IP must be attached and ‘associated_private_ip’ in the payload needs to be set with a new workload VM private IP. For ‘rename’, the ‘name’ in the payload needs to have a new name string. (required)
• sddc_public_ip_object (com.vmware.vmc.model_client.SddcPublicIp) – SddcPublicIp object to update (required)

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 updates

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 public IP with given IP address

Raise:

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

class com.vmware.vmc.orgs.sddcs_client.SddcTemplate(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(org, sddc)

Get configuration template for an SDDC

Parameters:

• org (str) – Organization identifier. (required)
• sddc (str) – Sddc Identifier. (required)

Return type:

com.vmware.vmc.model_client.SddcTemplate

Returns:

com.vmware.vmc.model.SddcTemplate

Raise:

com.vmware.vapi.std.errors_client.InvalidRequest SDDC is in a state that cannot be use for generating configuration template

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

class com.vmware.vmc.orgs.sddcs_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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