com.vmware.nsx_policy.cluster package¶

Submodules¶

com.vmware.nsx_policy.cluster.backups_client module¶

class com.vmware.nsx_policy.cluster.backups_client.Config(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get()¶

Get a configuration of a file server and timers for automated backup. Fields that contain secrets (password, passphrase) are not returned.

Return type: com.vmware.nsx_policy.model_client.BackupConfiguration
Returns: com.vmware.nsx_policy.model.BackupConfiguration
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

update(backup_configuration)¶

Configure file server and timers for automated backup. If secret fields are omitted (password, passphrase) then use the previously set value.

Parameters: backup_configuration (com.vmware.nsx_policy.model_client.BackupConfiguration) – (required)
Return type: com.vmware.nsx_policy.model_client.BackupConfiguration
Returns: com.vmware.nsx_policy.model.BackupConfiguration
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.cluster.backups_client.History(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get()¶

Get history of previous backup operations

Return type: com.vmware.nsx_policy.model_client.BackupOperationHistory
Returns: com.vmware.nsx_policy.model.BackupOperationHistory
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.cluster.backups_client.Status(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get()¶

Get status of active backup operations

Return type: com.vmware.nsx_policy.model_client.CurrentBackupOperationStatus
Returns: com.vmware.nsx_policy.model.CurrentBackupOperationStatus
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.cluster.backups_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.nsx_policy.cluster.restore_client module¶

class com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Returns timestamps for all backup files that are available on the SFTP server.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.ClusterBackupInfoListResult

Returns

com.vmware.nsx_policy.model.ClusterBackupInfoListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.cluster.restore_client.Config(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get()¶

Get configuration information for the file server used to store backed-up files. Fields that contain secrets (password, passphrase) are not returned.

Return type: com.vmware.nsx_policy.model_client.RestoreConfiguration
Returns: com.vmware.nsx_policy.model.RestoreConfiguration
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

update(restore_configuration)¶

Configure file server where the backed-up files used for the Restore operation are available.

Parameters: restore_configuration (com.vmware.nsx_policy.model_client.RestoreConfiguration) – (required)
Return type: com.vmware.nsx_policy.model_client.RestoreConfiguration
Returns: com.vmware.nsx_policy.model.RestoreConfiguration
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.cluster.restore_client.InstructionResources(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(instruction_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

For restore operations requiring user input e.g. performing an action, accepting/rejecting an action, etc. the information to be conveyed to users is provided in this call.

Parameters

instruction_id (str) – Id of the instruction set whose instructions are to be returned (required)
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.ActionableResourceListResult

Returns

com.vmware.nsx_policy.model.ActionableResourceListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.cluster.restore_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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