com.vmware.vmc package

Subpackages

• com.vmware.vmc.draas package
  • Submodules
  • com.vmware.vmc.draas.model_client module

Submodules

com.vmware.vmc.draas_client module

class com.vmware.vmc.draas_client.EnableVrScaleOut(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)

Enable VR scale out for Activated with DR SDDC

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

Return type

com.vmware.vmc.draas.model_client.Task

Returns

com.vmware.vmc.draas.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.draas_client.GenerateOauthClient(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, site_recovery_node)

Generate Oauth Client for Site Recovery node

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• site_recovery_node (str) – Site recovery node identifier (required)

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.draas_client.GetSrmConfigExport(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, srm_node)

Get content of the config export file needed for CVDS migration.

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• srm_node (str) – SRM node identifier (required)

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 config-export file in the site recovery node target path

class com.vmware.vmc.draas_client.GranularReporter(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

create_usage_report(org, report_period_config=None)

Create granular usage report for specific time period

Parameters

• org (str) – Organization identifier (required)

• report_period_config (com.vmware.vmc.draas.model_client.ReportPeriodConfig or None) – Report period configurations (optional)

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.draas_client.ReplicaData(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 VSR replica data per host

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

Return type

vmware.vapi.struct.VapiStruct

Returns

DynamicStructure

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 Not found

class com.vmware.vmc.draas_client.ReplicaDiskCollections(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, datastore_mo_id=None)

Query replica disk collections

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• datastore_mo_id (str or None) – Represents the datastore moref id to search. (optional)

Return type

list of com.vmware.vmc.draas.model_client.ReplicaDiskCollection

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 Not found

class com.vmware.vmc.draas_client.ReplicationsData(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)

Get outgoing and incoming replications data.

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

Return type

list of com.vmware.vmc.draas.model_client.ReplicationData

Returns

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.draas_client.SiteRecovery(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(org, sddc, delete_config_internal=None)

Deactivate site recovery for the specified sddc

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• delete_config_internal (com.vmware.vmc.draas.model_client.DeleteConfigInternal or None) – Customization, for example if deactivate site recovery forcefully and the CSSD/CSCM ticket number and the confirmation code. (optional)

Return type

com.vmware.vmc.draas.model_client.Task

Returns

com.vmware.vmc.draas.model.Task

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid action or bad argument

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find site recovery configuration for sddc identifier

get(org, sddc)

Query site recovery configuration for the specified sddc

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

Return type

com.vmware.vmc.draas.model_client.SiteRecovery

Returns

com.vmware.vmc.draas.model.SiteRecovery

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid action or bad argument

Raise

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

post(org, sddc, activate_site_recovery_config=None)

Activate site recovery for the specified sddc

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• activate_site_recovery_config (com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig or None) – Customization, for example can specify custom extension key suffix for SRM. (optional)

Return type

com.vmware.vmc.draas.model_client.Task

Returns

com.vmware.vmc.draas.model.Task

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid action or bad argument

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find site recovery configuration for sddc identifier

class com.vmware.vmc.draas_client.SiteRecoverySrmNodes(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(org, sddc, srm_node)

Delete a SRM server.

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• srm_node (str) – SRM node identifier (required)

Return type

com.vmware.vmc.draas.model_client.Task

Returns

com.vmware.vmc.draas.model.Task

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid action or bad argument

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find SDDC or SRM node

post(org, sddc, provision_srm_config=None)

Provision an additional SRM server.

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• provision_srm_config (com.vmware.vmc.draas.model_client.ProvisionSrmConfig or None) – Customization, for example can specify custom extension key suffix for SRM. (optional)

Return type

com.vmware.vmc.draas.model_client.Task

Returns

com.vmware.vmc.draas.model.Task

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid action or bad argument

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find site recovery configuration for sddc identifier

class com.vmware.vmc.draas_client.SiteRecoveryVersions(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)

Query site recovery versions for the specified sddc

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

Return type

com.vmware.vmc.draas.model_client.SiteRecoveryVersions

Returns

com.vmware.vmc.draas.model.SiteRecoveryVersions

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid action or bad argument

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Cannot find site recovery versions for sddc identifier

class com.vmware.vmc.draas_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.draas_client.Task(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(org, task)

Retrieve details of a task.

Parameters

• org (str) – Organization identifier (required)

• task (str) – task identifier (required)

Return type

com.vmware.vmc.draas.model_client.Task

Returns

com.vmware.vmc.draas.model.Task

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 task with given identifier

list(org, filter=None)

List all tasks with optional filtering.

Parameters

• org (str) – Organization identifier (required)

• filter (str or None) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, ‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-’ (minus) String Operators: ‘startswith’, ‘endswith’, ‘length’, ‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed using ‘.’ Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal ‘created’ will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq ‘READY’) (optional)

Return type

list of com.vmware.vmc.draas.model_client.Task

Returns

Raise

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

Raise

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

update(org, task, action=None)

Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status.

Parameters

• org (str) – Organization identifier (required)

• task (str) – task identifier (required)

• action (str or None) – If = ‘cancel’, task will be canceled (optional)

Return type

com.vmware.vmc.draas.model_client.Task

Returns

com.vmware.vmc.draas.model.Task

Raise

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

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Invalid action or bad argument

Raise

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

Raise

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

class com.vmware.vmc.draas_client.VrReplicationIssues(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)

Query VR replication issues

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

Return type

list of com.vmware.vmc.draas.model_client.HmsReplicationIssueInfo

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 Not found

class com.vmware.vmc.draas_client.VrSiteIssues(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)

Query VR site issues

Parameters

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

Return type

list of com.vmware.vmc.draas.model_client.HmsSiteIssueInfo

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 Not found