com.vmware.vmc.orgs.sddcs package

Subpackages

• com.vmware.vmc.orgs.sddcs.clusters package
  • Submodules
  • com.vmware.vmc.orgs.sddcs.clusters.config_client module
• 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.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.HostProvisionSpec(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, cluster, action=None)

Get host provision spec for a new host in a cluster in an sddc

Parameters

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

• sddc (str) – Sddc Identifier. (required)

• cluster (str) – cluster identifier (required)

• action (str or None) – If = ‘scale’, Will get provisioning spec for add host operations for scaling the cluster/sddc. If = ‘remediate’, Will get provisioning spec for add host operations for all internal operations (remediation, maintenance etc). Default behaviour is ‘scale’ (optional)

Return type

com.vmware.vmc.model_client.HostProvisionSpec

Returns

com.vmware.vmc.model.HostProvisionSpec

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

com.vmware.vmc.orgs.sddcs.networks_client module

class com.vmware.vmc.orgs.sddcs.networks_client.Edges(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, edge_type, prev_edge_id=None, start_index=None, page_size=None, sort_order_ascending=None, sort_by=None, filter=None, ld_rname=None)

Retrieve information about all management and compute gateways and other routers (NSX Edges).

Parameters

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

• sddc (str) – Sddc Identifier. (required)

• edge_type (str) – Retrieve records matching NSX Edge type (‘gatewayServices’ or ‘distributedRouter’). Specify gatewayServices to find management and compute gateways in your SDDC. (required)

• prev_edge_id (str or None) – Provide Edge ID as prevEdgeId to serve as reference for startIndex. (optional)

• start_index (long or None) – Start index for the current page. Default is 0. (optional)

• page_size (long or None) – Number of records per page. Default is 256. (optional)

• sort_order_ascending (bool or None) – Set to true to fetch records in ascending sorted order. (optional)

• sort_by (str or None) – Sort records using one of the column names (id, name, description, tenantId, size, enableFips). (optional)

• filter (str or None) – Filter records matching the NSX Edge ID, name or description. (optional)

• ld_rname (str or None) – (optional)

Return type

com.vmware.vmc.model_client.PagedEdgeList

Returns

com.vmware.vmc.model.PagedEdgeList

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad request. Request object passed is invalid.

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden. Authorization header not provided

Raise

com.vmware.vapi.std.errors_client.NotFound Not found. Requested object not found.

class com.vmware.vmc.orgs.sddcs.networks_client.Logical(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, sddc_network)

Create a network in an SDDC.

Parameters

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

• sddc (str) – Sddc Identifier. (required)

• sddc_network (com.vmware.vmc.model_client.SddcNetwork) – (required)

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad request. Request object passed is invalid.

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden. Authorization header not provided.

Raise

com.vmware.vapi.std.errors_client.NotFound Not found. Requested object not found.

delete(org, sddc, network_id)

Delete a network in an SDDC.

Parameters

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

• sddc (str) – Sddc Identifier. (required)

• network_id (str) – Logical Network Identifier (required)

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad request. Request object passed is invalid.

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden. Authorization header not provided.

Raise

com.vmware.vapi.std.errors_client.NotFound Not found. Requested object not found.

get(org, sddc, network_id)

Retrieve information about a network in an SDDC.

Parameters

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

• sddc (str) – Sddc Identifier. (required)

• network_id (str) – Logical Network Identifier (required)

Return type

com.vmware.vmc.model_client.SddcNetwork

Returns

com.vmware.vmc.model.SddcNetwork

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad request. Request object passed is invalid.

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden. Authorization header not provided

Raise

com.vmware.vapi.std.errors_client.NotFound Not found. Requested object not found.

get_0(org, sddc, page_size=None, start_index=None, prev_sddc_network_id=None, sort_order_ascending=None)

Retrieve all networks in an SDDC.

Parameters

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

• sddc (str) – Sddc Identifier. (required)

• page_size (long or None) – Page size for pagination. (optional)

• start_index (long or None) – Start index of page. (optional)

• prev_sddc_network_id (str or None) – Previous logical network id. (optional)

• sort_order_ascending (bool or None) – Sort order ascending. (optional)

Return type

com.vmware.vmc.model_client.DataPageSddcNetwork

Returns

com.vmware.vmc.model.DataPageSddcNetwork

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad request. Request object passed is invalid.

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden. Authorization header not provided

Raise

com.vmware.vapi.std.errors_client.NotFound Not found. Requested object not found.

update(org, sddc, network_id, sddc_network)

Modify a network in an SDDC.

Parameters

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

• sddc (str) – Sddc Identifier. (required)

• network_id (str) – Logical Network Identifier (required)

• sddc_network (com.vmware.vmc.model_client.SddcNetwork) – (required)

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad request. Request object passed is invalid.

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden. Authorization header not provided.

Raise

com.vmware.vapi.std.errors_client.NotFound Not found. Requested object not found.

class com.vmware.vmc.orgs.sddcs.networks_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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