use

Documentation of use proto files.


ostorlab.agent.message.proto.v3.use.device

LoginPassword

FieldTypeLabelDescription
usernamestringoptionalUsername for login.
passwordstringoptionalPassword for login.

SSHKey

FieldTypeLabelDescription
private_keystringoptionalPrivate SSH key.
public_keystringoptionalPublic SSH key.

Credentials

FieldTypeLabelDescription
login_passwordLoginPasswordoneofLogin password credentials.
ssh_keySSHKeyoneofSSH key credentials.

DeviceRelay

FieldTypeLabelDescription
namestringoptionalName of the device relay.
addressstringoptionalAddress of the device relay.
portsint32optionalPort of the device relay.

Duration

FieldTypeLabelDescription
nanosint32optionalDuration in nanoseconds.
secondsint64optionalDuration in seconds.

Argument

FieldTypeLabelDescription
arg_namestringoptionalArgument name.
arg_valuestringrepeatedArgument value.
arg_value_bytesbytesrepeatedArgument value as bytes.

Message

FieldTypeLabelDescription
device_idstringoptionalDevice identifier.
device_typestringoptionalDevice type, e.g., Android Phone, iPhone, etc.
device_namestringoptionalDevice name.
device_versionstringoptionalDevice version.
device_credentialsCredentialsoptionalDevice credentials.
device_relayDeviceRelayoptionalRelay through which the device can be accessed.
device_relay_credentialsCredentialsoptionalCredentials to access the relay.
durationDurationoptionalDuration the device is expected to be used.
argsArgumentrepeatedSet of arguments to be passed to the device.