cterasdk.edge.ctera_migrate module#
- class cterasdk.edge.ctera_migrate.CTERAMigrate(edge)#
Bases:
BaseCommand
Edge Filer Migration Tool APIs
- delete(tasks)#
Delete tasks
- Parameters:
tasks (list(cterasdk.common.object.Object)) – List of tasks
- details(task)#
Get task details
Log in
- Parameters:
credentials (cterasdk.edge.types.HostCredentials) – Target host credentials
- list_tasks(deleted=False)#
List tasks
- Parameters:
deleted (bool,optional) – List deleted tasks, defaults to
False
- Returns:
List of tasks
- Return type:
- login()#
Login to CTERA Migrate
- restore(tasks)#
Recover tasks
- Parameters:
tasks (list(cterasdk.common.object.Object)) – List of tasks
- results(task)#
- start(task)#
Start a task
- Parameters:
task (cterasdk.common.object.Object) – Task object
- stop(task)#
Stop a task
- Parameters:
task (cterasdk.common.object.Object) – Task object
- class cterasdk.edge.ctera_migrate.Discovery(ctera_migrate)#
Bases:
TaskManager
- add(name, credentials, shares, auto_start=False, log_every_file=False, notes=None)#
Create a discovery task
- Parameters:
name (str) – Task name
credentials (cterasdk.edge.types.HostCredentials) – Target host credentials
auto_start (bool,optional) – Start task after creation, defaults to
False
log_every_file (bool,optional) – Log every file, defaults to
False
notes (str,optional) – Task notes
- Returns:
Task
- Return type:
- list_tasks(deleted=False)#
- update(task, name=None, notes=None)#
Update a discovery task
- Parameters:
name (str,optional) – Task name
notes (str,optional) – Task notes
- class cterasdk.edge.ctera_migrate.DiscoveryTask(task_id, task_type, name, created_at, source, source_type, last_status, shares, notes, log_every_file)#
Bases:
Task
Class representing a migration tool discovery task
- class cterasdk.edge.ctera_migrate.Jobs(jobs)#
Bases:
object
Class representing task jobs
- property all#
Get all jobs of a task
- property latest#
Get the latest job of a task
- class cterasdk.edge.ctera_migrate.Migration(ctera_migrate)#
Bases:
TaskManager
- add(name, credentials, shares, auto_start=False, access_time=None, winacls=True, cloud_folder=None, create_cloud_folder_per_share=False, compute_checksum=False, exclude=None, include=None, notes=None)#
Create a discovery task
- Parameters:
name (str) – Task name
credentials (cterasdk.edge.types.HostCredentials) – Target host credentials
auto_start (bool,optional) – Start task after creation, defaults to
False
access_time (bool,optional) – Copy last access time, defaults to
None
winacls (bool,optional) – Copy NTFS ACL’s, defaults to
True
cloud_folder (str,optional) – Target cloud folder, if
create_cloud_folder_per_share
was set toTrue
then this attribute serves as the cloud folder name prefixcreate_cloud_folder_per_share (bool,optional) – Create cloud folder per share, defaults to
False
compute_checksum (bool,optional) – Validate and report checksums post-migration, defaults to
False
exclude (list(str),optional) – List of patterns to exclude, defaults to
None
include (list(str),optional) – List of patterns to include, defaults to
None
notes (str,optional) – Task notes
- Returns:
Task
- Return type:
- list_tasks(deleted=False)#
- class cterasdk.edge.ctera_migrate.MigrationTask(task_id, task_type, name, created_at, source, source_type, last_status, shares, notes, winacls, cloud_folder, create_cloud_folder_per_share, compute_checksum, exclude, include, access_time, schedule, throttling)#
Bases:
Task
Class representing a migration tool migration task
- class cterasdk.edge.ctera_migrate.Task(task_id, task_type, name, created_at=None, source=None, source_type=None, last_status=None, shares=None, notes=None)#
Bases:
Object
Class representing a migration tool task
- static from_server_object(server_object)#
- class cterasdk.edge.ctera_migrate.TaskManager(ctera_migrate)#
Bases:
object
Class representing a migration tool task