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.networking_client module
  • com.vmware.vmc.orgs.sddcs.networks_client module

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.Unauthorized Access not allowed to the operation for the current user

Raise:

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

put(org, reservation, window)

update the maintenance window for this SDDC

Parameters:

• org (str) – Organization identifier. (required)
• reservation (str) – Reservation Identifier (required)
• window (com.vmware.vmc.model_client.MaintenanceWindow) – Maintenance Window (required)

Return type:

com.vmware.vmc.model_client.MaintenanceWindow

Returns:

com.vmware.vmc.model.MaintenanceWindow

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.ConcurrentChange Conflict with exiting reservation

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

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:

• 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

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:

• org (str) – Organization identifier. (required)
• sddc_state (com.vmware.vmc.model_client.SddcStateRequest or None) – SDDCs and/or states to query (optional)

Return type:

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

Returns:

Raise:

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

Raise:

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

Raise:

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

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)

Get all available support windows

Parameters:org (str) – Organization identifier. (required) Return type:list of com.vmware.vmc.model_client.SupportWindow Returns: 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 Raise:com.vmware.vapi.std.errors_client.Unauthenticated Unauthorized

put(org, id, sddc_id=None)

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 or None) – SDDC to move (optional)

Return type:

com.vmware.vmc.model_client.SupportWindow

Returns:

com.vmware.vmc.model.SupportWindow

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

Raise:

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