Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Child pages (Children Display)

Excerpt
hiddentrue


Attributes
Type
Description
descriptionString

This is a description of the Endpoint.

OPTIONAL

connectionTypeString

This specifies the connection Type.

MANDATORY: "SSH" or "LOCALHOST"

isActiveBoolean

This is a Boolean that tracks whether or not the Endpoint is active. 

MANDATORY

endpointAddressString

This is a String associated with the address of the endpoint.

DEPENDENT: Mandatory when connectionType is "SSH", otherwise not used.

endpointPortString

This is a port associated with an SSH connection.

DEPENDENT: Mandatory when connectionType is "SSH", otherwise not used.

endpointIdLong

This is a number associated with the identification number of an existing Endpoint.

UNIQUE

passwordString

This is a character sequence used to access the corresponding remote connection.

DEPENDENT: Optional when connectionType is "SSH" otherwise not used.

endpointNameString

This is the unique name of the corresponding Endpoint.

UNIQUE

privateKeyString

This is a character sequence associated with the corresponding remote connection.

DEPENDENT: Optional when connectionType is "SSH" otherwise not used.

osTypeString

This is a character sequence which corresponds to the operating system type used in the corresponding remote connection.

DEPENDENT: Mandatory when connectionType is "SSH" otherwise not used.

baseDirectoryString

This is a character sequence which corresponds to the base directory of the corresponding Endpoint.

MANDATORY

endpointSubgroupStringThis is a character sequence associated with this Endpoint's corresponding sub-group.
passphraseString

This is a character sequence associated with the correspond remote connection.

DEPENDENT: Optional when connectionType is "SSH" otherwise not used.

javaPathString

This is a character sequence that specifies the java path of the corresponding Endpoint.

MANDATORY

runAsUserNameString

This is a character sequence that specifies the runAsUserName variable.

DEPENDENT: Optional when connection Type is "SSH" otherwise not used.