Thrift module: data_movement_models

Module	Services	Data types	Constants
data_movement_models		DMType DataMovementInterface DataMovementProtocol GridFTPDataMovement LOCALDataMovement SCPDataMovement SecurityProtocol UnicoreDataMovement

Enumerations

Enumeration: DMType

`COMPUTE_RESOURCE`	`0`
`STORAGE_RESOURCE`	`1`

Enumeration: SecurityProtocol

Enumeration of security sshKeyAuthentication and authorization mechanisms supported by Airavata. This enumeration just
 describes the supported mechanism. The corresponding security credentials are registered with Airavata Credential
 store.

USERNAME_PASSWORD:
 A User Name.

SSH_KEYS:
 SSH Keys

FIXME: Change GSI to a more precise generic security protocol - X509

`USERNAME_PASSWORD`	`0`
`SSH_KEYS`	`1`
`GSI`	`2`
`KERBEROS`	`3`
`OAUTH`	`4`
`LOCAL`	`5`

Enumeration: DataMovementProtocol

Enumeration of data movement supported by Airavata

SCP:
 Job manager supporting the Portal Batch System (PBS) protocol. Some examples include TORQUE, PBSPro, Grid Engine.

SFTP:
 The Simple Linux Utility for Resource Management is a open source workload manager.

GridFTP:
 Globus File Transfer Protocol

UNICORE_STORAGE_SERVICE:
 Storage Service Provided by Unicore

`LOCAL`	`0`
`SCP`	`1`
`SFTP`	`2`
`GridFTP`	`3`
`UNICORE_STORAGE_SERVICE`	`4`

Data structures

Struct: SCPDataMovement

Key	Field	Type	Requiredness	Default value
1	dataMovementInterfaceId	`string`	required	`"DO_NOT_SET_AT_CLIENTS"`
2	securityProtocol	`SecurityProtocol`	required
3	alternativeSCPHostName	`string`	optional
4	sshPort	`i32`	optional	`22`

Data Movement through Secured Copy

alternativeSCPHostName:
 If the login to scp is different than the hostname itself, specify it here

sshPort:
 If a non-default port needs to used, specify it.

Struct: GridFTPDataMovement

Key	Field	Type	Requiredness	Default value
1	dataMovementInterfaceId	`string`	required	`"DO_NOT_SET_AT_CLIENTS"`
2	securityProtocol	`SecurityProtocol`	required
3	gridFTPEndPoints	`list<string>`	required

Data Movement through GridFTP

alternativeSCPHostName:
 If the login to scp is different than the hostname itself, specify it here

sshPort:
 If a non-default port needs to used, specify it.

Struct: UnicoreDataMovement

Key	Field	Type	Requiredness	Default value
1	dataMovementInterfaceId	`string`	required	`"DO_NOT_SET_AT_CLIENTS"`
2	securityProtocol	`SecurityProtocol`	required
3	unicoreEndPointURL	`string`	required

Data Movement through UnicoreStorage

unicoreEndPointURL:
 unicoreGateway End Point. The provider will query this service to fetch required service end points.

Struct: LOCALDataMovement

Key	Field	Type	Description	Requiredness	Default value
1	dataMovementInterfaceId	`string`		required	`"DO_NOT_SET_AT_CLIENTS"`

LOCAL

alternativeSCPHostName:
 If the login to scp is different than the hostname itself, specify it here

sshPort:
 If a non-defualt port needs to used, specify it.

Struct: DataMovementInterface

Key	Field	Type	Requiredness	Default value
1	dataMovementInterfaceId	`string`	required
2	dataMovementProtocol	`DataMovementProtocol`	required
3	priorityOrder	`i32`	required	`0`
4	creationTime	`i64`	optional
5	updateTime	`i64`	optional
6	storageResourceId	`string`	optional

Data Movement Interfaces

dataMovementInterfaceId: The Data Movement Interface has to be previously registered and referenced here.

priorityOrder:
 For resources with multiple interfaces, the priority order should be selected.
  Lower the numerical number, higher the priority
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



source/api-docs/master/data_movement_models.html [1:144]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -





Thrift module: data_movement_models

Thrift module: data_movement_models
Module Services Data types Constants


data_movement_models 
DMType

DataMovementInterface

DataMovementProtocol

GridFTPDataMovement

LOCALDataMovement

SCPDataMovement

SecurityProtocol

UnicoreDataMovement




Enumerations
Enumeration: DMType


COMPUTE_RESOURCE 0 

STORAGE_RESOURCE 1 


Enumeration: SecurityProtocol
Enumeration of security sshKeyAuthentication and authorization mechanisms supported by Airavata. This enumeration just
 describes the supported mechanism. The corresponding security credentials are registered with Airavata Credential
 store.

USERNAME_PASSWORD:
 A User Name.

SSH_KEYS:
 SSH Keys

FIXME: Change GSI to a more precise generic security protocol - X509




USERNAME_PASSWORD 0 

SSH_KEYS 1 

GSI 2 

KERBEROS 3 

OAUTH 4 

LOCAL 5 


Enumeration: DataMovementProtocol
Enumeration of data movement supported by Airavata

SCP:
 Job manager supporting the Portal Batch System (PBS) protocol. Some examples include TORQUE, PBSPro, Grid Engine.

SFTP:
 The Simple Linux Utility for Resource Management is a open source workload manager.

GridFTP:
 Globus File Transfer Protocol

UNICORE_STORAGE_SERVICE:
 Storage Service Provided by Unicore




LOCAL 0 

SCP 1 

SFTP 2 

GridFTP 3 

UNICORE_STORAGE_SERVICE 4 


Data structures
Struct: SCPDataMovement
Key Field Type Description Requiredness Default value

1 dataMovementInterfaceId string required "DO_NOT_SET_AT_CLIENTS"
2 securityProtocol SecurityProtocol required 
3 alternativeSCPHostName string optional 
4 sshPort i32 optional 22

Data Movement through Secured Copy

alternativeSCPHostName:
 If the login to scp is different than the hostname itself, specify it here

sshPort:
 If a non-default port needs to used, specify it.

Struct: GridFTPDataMovement
Key Field Type Description Requiredness Default value

1 dataMovementInterfaceId string required "DO_NOT_SET_AT_CLIENTS"
2 securityProtocol SecurityProtocol required 
3 gridFTPEndPoints list<string> required 

Data Movement through GridFTP

alternativeSCPHostName:
 If the login to scp is different than the hostname itself, specify it here

sshPort:
 If a non-default port needs to used, specify it.

Struct: UnicoreDataMovement
Key Field Type Description Requiredness Default value

1 dataMovementInterfaceId string required "DO_NOT_SET_AT_CLIENTS"
2 securityProtocol SecurityProtocol required 
3 unicoreEndPointURL string required 

Data Movement through UnicoreStorage

unicoreEndPointURL:
 unicoreGateway End Point. The provider will query this service to fetch required service end points.

Struct: LOCALDataMovement
Key Field Type Description Requiredness Default value

1 dataMovementInterfaceId string required "DO_NOT_SET_AT_CLIENTS"

LOCAL

alternativeSCPHostName:
 If the login to scp is different than the hostname itself, specify it here

sshPort:
 If a non-defualt port needs to used, specify it.

Struct: DataMovementInterface
Key Field Type Description Requiredness Default value

1 dataMovementInterfaceId string required 
2 dataMovementProtocol DataMovementProtocol required 
3 priorityOrder i32 required 0
4 creationTime i64 optional 
5 updateTime i64 optional 
6 storageResourceId string optional 

Data Movement Interfaces

dataMovementInterfaceId: The Data Movement Interface has to be previously registered and referenced here.

priorityOrder:
 For resources with multiple interfaces, the priority order should be selected.
  Lower the numerical number, higher the priority
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -