com.vmware.vmc.orgs package

Subpackages

Submodules

com.vmware.vmc.orgs.reservations_client module

class com.vmware.vmc.orgs.reservations_client.Mw(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(org, reservation)

get the maintenance window for this SDDC

Parameters
  • org (str) – Organization identifier. (required)

  • reservation (str) – Reservation Identifier (required)

Return type

com.vmware.vmc.model_client.MaintenanceWindowGet

Returns

com.vmware.vmc.model.MaintenanceWindowGet

Raise

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

Raise

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

put(org, reservation, window)

update the maintenance window for this SDDC

Parameters
Return type

com.vmware.vmc.model_client.MaintenanceWindow

Returns

com.vmware.vmc.model.MaintenanceWindow

Raise

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

Raise

com.vmware.vapi.std.errors_client.ConcurrentChange Conflict with exiting reservation

Raise

com.vmware.vapi.std.errors_client.InvalidRequest The reservation 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

class com.vmware.vmc.orgs.reservations_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)

Creates a new cluster in customers sddcs with passed clusterConfig.

Parameters
Return type

com.vmware.vmc.model_client.Task

Returns

com.vmware.vmc.model.Task

Raise

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

Raise

com.vmware.vapi.std.errors_client.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

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.Unauthenticated Unauthorized

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

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.Unauthenticated Unauthorized

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

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). If = ‘attach-diskgroup’, will attach the provided diskgroups to a given host (privileged). If = ‘detach-diskgroup’, will detach the diskgroups of a given host (privileged). 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.Unauthenticated Unauthorized

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

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(org)

Get sddc provision spec for an org

Parameters

org (str) – Organization identifier. (required)

Return type

com.vmware.vmc.model_client.ProvisionSpec

Returns

com.vmware.vmc.model.ProvisionSpec

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest BadRequest

Raise

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

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal server error.

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
Return type

com.vmware.vmc.model_client.Task

Returns

com.vmware.vmc.model.Task

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest The sddc is not in a state that’s valid for 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

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.Unauthenticated Unauthorized

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

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.Unauthenticated Unauthorized

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

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.Unauthenticated Unauthorized

Raise

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

Raise

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

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.Unauthenticated Unauthorized

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

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.Unauthenticated Unauthorized

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

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

com.vmware.vmc.orgs.storage_client module

class com.vmware.vmc.orgs.storage_client.ClusterConstraints(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(org, provider, num_hosts, one_node_reduced_capacity=None)

Get constraints on cluster storage size for EBS-backed clusters.

Parameters
  • org (str) – Organization identifier. (required)

  • provider (str) – Cloud storage provider ID (example AWS) (required)

  • num_hosts (long) – Number of hosts in cluster (required)

  • one_node_reduced_capacity (bool or None) – Whether this sddc is reduced capacity 1NODE. (optional)

Return type

com.vmware.vmc.model_client.VsanConfigConstraints

Returns

com.vmware.vmc.model.VsanConfigConstraints

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid or missing parameters

Raise

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

class com.vmware.vmc.orgs.storage_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.subscriptions_client module

class com.vmware.vmc.orgs.subscriptions_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, product=None, type=None)

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. *This has been deprecated*. Please use product & type parameters (required)

  • product (str or None) – The product that you are trying to purchase, eg. host. This needs to be accompanied by the type parameter (optional)

  • type (str or None) – The type/flavor of the product you are trying it purchase,eg. an `r5.metal` host. This needs to be accompanied by the product parameter. (optional)

Return type

com.vmware.vmc.model_client.OfferInstancesHolder

Returns

com.vmware.vmc.model.OfferInstancesHolder

Raise

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

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

class com.vmware.vmc.orgs.subscriptions_client.Products(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

list(org)

List of all the products that are available for purchase.

Parameters

org (str) – Organization identifier. (required)

Return type

list of com.vmware.vmc.model_client.SubscriptionProducts

Returns

Raise

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

Raise

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

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal server error

class com.vmware.vmc.orgs.subscriptions_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.tbrs_client module

class com.vmware.vmc.orgs.tbrs_client.Reservation(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

post(org, sddc_state=None)

Retreive all reservations for all SDDCs in this org

Parameters
Return type

dict of str and list of com.vmware.vmc.model_client.ReservationWindow

Returns

Raise

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

Raise

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

Raise

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

class com.vmware.vmc.orgs.tbrs_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.tbrs_client.SupportWindow(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(org, minimum_seats_available=None, created_by=None)

Get all available support windows

Parameters
  • org (str) – Organization identifier. (required)

  • minimum_seats_available (long or None) – minimum seats available (used as a filter) (optional)

  • created_by (str or None) – user name which was used to create the support window (used as a filter) (optional)

Return type

list of com.vmware.vmc.model_client.SupportWindow

Returns

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid request

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound No support windows are available

put(org, id, sddc_id)

Move Sddc to new support window

Parameters
  • org (str) – Organization identifier. (required)

  • id (str) – Target Support Window ID (required)

  • sddc_id (com.vmware.vmc.model_client.SddcId) – SDDC to move (required)

Return type

com.vmware.vmc.model_client.SupportWindowId

Returns

com.vmware.vmc.model.SupportWindowId

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid request

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Feature does not exist