com.vmware.vmc.orgs.sddcs package¶

Subpackages¶

com.vmware.vmc.orgs.sddcs.clusters package

Submodules¶

com.vmware.vmc.orgs.sddcs.addons_client module¶

class com.vmware.vmc.orgs.sddcs.addons_client.Credentials(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

CREATE_ADDON_TYPE_HCX = 'HCX'¶: Possible value for addonType of method Credentials.create().

GET_ADDON_TYPE_HCX = 'HCX'¶: Possible value for addonType of method Credentials.get().

LIST_ADDON_TYPE_HCX = 'HCX'¶: Possible value for addonType of method Credentials.list().

UPDATE_ADDON_TYPE_HCX = 'HCX'¶: Possible value for addonType of method Credentials.update().

create(org, sddc_id, addon_type, credentials)¶

Associated a new add on credentials with the SDDC such as HCX

Parameters

org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
credentials (com.vmware.vmc.model_client.NewCredentials) – Credentials creation payload (required)

Return type

com.vmware.vmc.model_client.NewCredentials

Returns

com.vmware.vmc.model.NewCredentials

Raise

com.vmware.vapi.std.errors_client.ConcurrentChange Credentials with same name exists with in the scope of addOnType

Raise

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

Raise

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

get(org, sddc_id, addon_type, name)¶

Get credential details by name

Parameters

org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)

Return type

com.vmware.vmc.model_client.NewCredentials

Returns

com.vmware.vmc.model.NewCredentials

Raise

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

list(org, sddc_id, addon_type)¶

List all the credentials assoicated with an addon type with in a SDDC

Parameters

org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)

Return type

list of com.vmware.vmc.model_client.NewCredentials

Returns

Raise

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

update(org, sddc_id, addon_type, name, credentials)¶

Update credential details

Parameters

org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
credentials (com.vmware.vmc.model_client.UpdateCredentials) – Credentials update payload (required)

Return type

com.vmware.vmc.model_client.NewCredentials

Returns

com.vmware.vmc.model.NewCredentials

Raise

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

Raise

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

class com.vmware.vmc.orgs.sddcs.addons_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.clusters_client module¶

class com.vmware.vmc.orgs.sddcs.clusters_client.Reconfigure(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

cluster_reconfig(org, sddc, cluster, cluster_reconfigure_params)¶

This reconfiguration will handle changing both the number of hosts and the cluster storage capacity.

Parameters

org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
cluster_reconfigure_params (com.vmware.vmc.model_client.ClusterReconfigureParams) – clusterReconfigureParams (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 Bad Request. The SDDC is not in a valid state. , 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 cluster with the given id

class com.vmware.vmc.orgs.sddcs.clusters_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.dns_client module¶

class com.vmware.vmc.orgs.sddcs.dns_client.Private(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

update(org, sddc)¶

Update the DNS records of management VMs to use private IP addresses

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 or invalid body

Raise

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

class com.vmware.vmc.orgs.sddcs.dns_client.Public(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

update(org, sddc)¶

Update the DNS records of management VMs to use public IP addresses

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 or invalid body

Raise

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

class com.vmware.vmc.orgs.sddcs.dns_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.management_vms_client module¶

class com.vmware.vmc.orgs.sddcs.management_vms_client.Dns(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

UPDATE_IP_TYPE_PRIVATE = 'private'¶: Possible value for ipType of method Dns.update().

UPDATE_IP_TYPE_PUBLIC = 'public'¶: Possible value for ipType of method Dns.update().

update(org, sddc, management_vm_id, ip_type)¶

Update the DNS records of management VMs to use public or private IP addresses

Parameters

org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
management_vm_id (str) – the management VM ID (required)
ip_type (str) – the ip type to associate with FQDN in DNS (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 or invalid body

Raise

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

class com.vmware.vmc.orgs.sddcs.management_vms_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.networking_client module¶

class com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests(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)¶

Retrieve metadata for connectivity tests.

Parameters

org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)

Return type

com.vmware.vmc.model_client.ConnectivityValidationGroups

Returns

com.vmware.vmc.model.ConnectivityValidationGroups

Raise

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

Raise

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

post(org, sddc, request_info, action)¶

ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’].

Parameters

org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
request_info (com.vmware.vmc.model_client.ConnectivityValidationGroup) – request information (required)
action (str) – If = ‘start’, start connectivity tests. (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 Bad Request

Raise

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

class com.vmware.vmc.orgs.sddcs.networking_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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